{
"openapi": "3.0.1",
"info": {
"title": "TempWorks OpenAPI",
"contact": {
"name": "TempWorks Development",
"url": "https://developer.ontempworks.com",
"email": "support@tempworks.com"
},
"version": "v 1"
},
"paths": {
"/Administration/AssessmentPackages": {
"get": {
"tags": [
"Administration"
],
"summary": "Get Assessment Packages",
"description": "Get a paged list of user defined assessment packages ordered by the package name.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "AdministrationAssessmentPackagesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.UserDefinedPackagesQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.UserDefinedPackagesQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.UserDefinedPackagesQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.UserDefinedPackagesQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.UserDefinedPackagesQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.UserDefinedPackagesQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.UserDefinedPackagesQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Administration"
],
"summary": "Create Assessment Package",
"description": "Create a user defined assessment package\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "AdministrationAssessmentPackagesPost",
"requestBody": {
"description": "The details of the assessment package.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.API.Models.CreateAssessmentPackageRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.API.Models.CreateAssessmentPackageRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.API.Models.CreateAssessmentPackageRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.API.Models.CreateAssessmentPackageRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.API.Models.CreateAssessmentPackageRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.API.Models.CreateAssessmentPackageRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.API.Models.CreateAssessmentPackageRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.API.Models.CreateAssessmentPackageRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.CreateUserDefinedPackage.Response"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.CreateUserDefinedPackage.Response"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.CreateUserDefinedPackage.Response"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.CreateUserDefinedPackage.Response"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.CreateUserDefinedPackage.Response"
}
}
}
}
}
}
},
"/Administration/AssessmentPackages/{id}": {
"get": {
"tags": [
"Administration"
],
"summary": "Get Assessment Package",
"description": "Get a user defined assessment package\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "AdministrationAssessmentPackagesByIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the assessment package.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.UserDefinedPackagesQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.UserDefinedPackagesQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.UserDefinedPackagesQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.UserDefinedPackagesQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.UserDefinedPackagesQuery.Result"
}
}
}
}
}
},
"delete": {
"tags": [
"Administration"
],
"summary": "Delete Assessment Package",
"description": "Delete a user defined assessment package.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "AdministrationAssessmentPackagesByIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
},
"put": {
"tags": [
"Administration"
],
"summary": "Update Assessment Package",
"description": "Update a user defined assessment package\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "AdministrationAssessmentPackagesByIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the user defined assessment package.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The details of the assessment package.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.API.Models.CreateAssessmentPackageRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.API.Models.CreateAssessmentPackageRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.API.Models.CreateAssessmentPackageRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.API.Models.CreateAssessmentPackageRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.API.Models.CreateAssessmentPackageRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.API.Models.CreateAssessmentPackageRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.API.Models.CreateAssessmentPackageRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.API.Models.CreateAssessmentPackageRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Administration/AssessmentPackages/{id}/Assessments": {
"get": {
"tags": [
"Administration"
],
"summary": "Get Assessments in Package",
"description": "Get a paged list of the user defined package members ordered by the assessment name.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "AdministrationAssessmentPackagesByIdAssessmentsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the user defined assessment package.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.UserDefinedPackageMembersQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.UserDefinedPackageMembersQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.UserDefinedPackageMembersQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.UserDefinedPackageMembersQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.UserDefinedPackageMembersQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.UserDefinedPackageMembersQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.UserDefinedPackageMembersQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Administration"
],
"summary": "Add Member to Package",
"description": "Adds a member to a user defined assessment package\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "AdministrationAssessmentPackagesByIdAssessmentsPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the user defined assessment package.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The details to add as a package member.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.API.Models.CreateUserDefinedPackageMemberRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.API.Models.CreateUserDefinedPackageMemberRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.API.Models.CreateUserDefinedPackageMemberRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.API.Models.CreateUserDefinedPackageMemberRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.API.Models.CreateUserDefinedPackageMemberRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.API.Models.CreateUserDefinedPackageMemberRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.API.Models.CreateUserDefinedPackageMemberRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.API.Models.CreateUserDefinedPackageMemberRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.CreateUserDefinedPackageMember.Response"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.CreateUserDefinedPackageMember.Response"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.CreateUserDefinedPackageMember.Response"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.CreateUserDefinedPackageMember.Response"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.CreateUserDefinedPackageMember.Response"
}
}
}
}
}
}
},
"/Administration/AssessmentPackages/{id}/Assessments/{assessmentPackageMemberId}": {
"get": {
"tags": [
"Administration"
],
"summary": "Get Package Members",
"description": "Get a user defined package member.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "AdministrationAssessmentPackagesByIdAssessmentsByAssessmentPackageMemberIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the user defined assessment package.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "assessmentPackageMemberId",
"in": "path",
"description": "The Id of the user defined assessment package member.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.UserDefinedPackageMembersQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.UserDefinedPackageMembersQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.UserDefinedPackageMembersQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.UserDefinedPackageMembersQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.UserDefinedPackageMembersQuery.Result"
}
}
}
}
}
},
"delete": {
"tags": [
"Administration"
],
"summary": "Remove Member from Package",
"description": "Removes a member from a user defined assessment package.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "AdministrationAssessmentPackagesByIdAssessmentsByAssessmentPackageMemberIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the user defined assessment package.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "assessmentPackageMemberId",
"in": "path",
"description": "The Id of the package member.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Assessments/Sessions/AssessOnCloud/Results": {
"post": {
"tags": [
"Assessments"
],
"summary": "Post Assess On Cloud Session Results",
"description": "Endpoint used to post Assess On Cloud session results. This endpoint will be registered during the session request.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): assessoncloudresults-write ````",
"operationId": "AssessmentsSessionsAssessOnCloudResultsPost",
"requestBody": {
"description": "The results for the candidates sessions",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.PostAssessOnCloudResultsCommand.AssessOnCloudSessionPostedResult"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.PostAssessOnCloudResultsCommand.AssessOnCloudSessionPostedResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.PostAssessOnCloudResultsCommand.AssessOnCloudSessionPostedResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.PostAssessOnCloudResultsCommand.AssessOnCloudSessionPostedResult"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.PostAssessOnCloudResultsCommand.AssessOnCloudSessionPostedResult"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.PostAssessOnCloudResultsCommand.AssessOnCloudSessionPostedResult"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.PostAssessOnCloudResultsCommand.AssessOnCloudSessionPostedResult"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.PostAssessOnCloudResultsCommand.AssessOnCloudSessionPostedResult"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.PostAssessOnCloudResultsCommand.Result.AssessOnCloudAcknowledgment"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.PostAssessOnCloudResultsCommand.Result.AssessOnCloudAcknowledgment"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.PostAssessOnCloudResultsCommand.Result.AssessOnCloudAcknowledgment"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.PostAssessOnCloudResultsCommand.Result.AssessOnCloudAcknowledgment"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.PostAssessOnCloudResultsCommand.Result.AssessOnCloudAcknowledgment"
}
}
}
}
}
}
},
"/Assessments/Sessions/AssessOnCloud/Status": {
"post": {
"tags": [
"Assessments"
],
"summary": "Post Assess On Cloud Session Status",
"description": "Endpoint used to post Assess On Cloud session status updates. This endpoint will be registered during the session request.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): assessoncloudresults-write ````",
"operationId": "AssessmentsSessionsAssessOnCloudStatusPost",
"requestBody": {
"description": "The update information regarding the change in session status.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.UpdateAssessOnCloudSessionStatus.AssessOnCloudSessionStatus"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.UpdateAssessOnCloudSessionStatus.AssessOnCloudSessionStatus"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.UpdateAssessOnCloudSessionStatus.AssessOnCloudSessionStatus"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.UpdateAssessOnCloudSessionStatus.AssessOnCloudSessionStatus"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.UpdateAssessOnCloudSessionStatus.AssessOnCloudSessionStatus"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.UpdateAssessOnCloudSessionStatus.AssessOnCloudSessionStatus"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.UpdateAssessOnCloudSessionStatus.AssessOnCloudSessionStatus"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.UpdateAssessOnCloudSessionStatus.AssessOnCloudSessionStatus"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.UpdateAssessOnCloudSessionStatus.Result.AssessOnCloudAcknowledgment"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.UpdateAssessOnCloudSessionStatus.Result.AssessOnCloudAcknowledgment"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.UpdateAssessOnCloudSessionStatus.Result.AssessOnCloudAcknowledgment"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.UpdateAssessOnCloudSessionStatus.Result.AssessOnCloudAcknowledgment"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.UpdateAssessOnCloudSessionStatus.Result.AssessOnCloudAcknowledgment"
}
}
}
}
}
}
},
"/Assessments/Sessions/Vendors/{id}/Results": {
"post": {
"tags": [
"Assessments"
],
"summary": "Post Assessment Results",
"description": "Endpoint used to post Assessment results.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): assessment-webhook ````",
"operationId": "AssessmentsSessionsVendorsByIdResultsPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the Assessment vendor.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "data",
"in": "query",
"description": "The vendor specific object containing the information about the assessment result. Serialized and passed in the body of the request.",
"style": "form",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Assignments": {
"post": {
"tags": [
"Assignment"
],
"summary": "Create Assignment",
"description": "Creates an assignment for the employee and job order supplied. Before an employee can be assigned, they must be vetted\r\nby an assignment restriction session and have no results or all of the results approved. An assignment restriction\r\nsession can be started at the jobOrder/{orderId}/assignmentRestriction endpoint.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): assignment-write ````",
"operationId": "AssignmentsPost",
"requestBody": {
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CreateAssignmentRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CreateAssignmentRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CreateAssignmentRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CreateAssignmentRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CreateAssignmentRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CreateAssignmentRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CreateAssignmentRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CreateAssignmentRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.CreateAssignmentCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.CreateAssignmentCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.CreateAssignmentCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.CreateAssignmentCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.CreateAssignmentCommand.Result"
}
}
}
}
}
}
},
"/Assignments/{assignmentId}/messages/{messageId}": {
"put": {
"tags": [
"Assignment"
],
"summary": "Update Message",
"description": "Updates a message and links it to the assignment.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): assignment-read or assignment-write ````",
"operationId": "AssignmentsByAssignmentIdMessagesByMessageIdPut",
"parameters": [
{
"name": "assignmentId",
"in": "path",
"description": "The Id of the assignment",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "messageId",
"in": "path",
"description": "The Id of the message",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The body of the request containing the information required to update the message.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.UpdateMessageWithLinkedDocumentsRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.UpdateMessageWithLinkedDocumentsRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.UpdateMessageWithLinkedDocumentsRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.UpdateMessageWithLinkedDocumentsRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.UpdateMessageWithLinkedDocumentsRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.UpdateMessageWithLinkedDocumentsRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.UpdateMessageWithLinkedDocumentsRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.UpdateMessageWithLinkedDocumentsRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/Assignments/{assignmentId}/messages/{messageId}/documents": {
"post": {
"tags": [
"Assignment"
],
"summary": "Upload document to a message",
"description": "\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): assignment-write ````",
"operationId": "AssignmentsByAssignmentIdMessagesByMessageIdDocumentsPost",
"parameters": [
{
"name": "assignmentId",
"in": "path",
"description": "The Id of the assignment.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "messageId",
"in": "path",
"description": "The Id of the message.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"required": [
"DocumentName",
"DocumentTypeId"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
},
"DocumentName": {
"type": "string"
},
"DocumentTypeId": {
"type": "integer",
"format": "int32"
},
"Description": {
"maxLength": 255,
"type": "string"
},
"ExpirationDate": {
"type": "string",
"format": "date-time"
},
"Version": {
"type": "string"
}
}
},
"encoding": {
"File": {
"style": "form"
},
"DocumentName": {
"style": "form"
},
"DocumentTypeId": {
"style": "form"
},
"Description": {
"style": "form"
},
"ExpirationDate": {
"style": "form"
},
"Version": {
"style": "form"
}
}
}
}
},
"responses": {
"201": {
"description": "Id of the new document.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
}
}
}
}
}
},
"/Assignments/{id}": {
"get": {
"tags": [
"Assignment"
],
"summary": "Get Details",
"description": "Gets detailed information about the specified assignment.\n \n```` Allows roles: ServiceRep, WebUserEmployee, Service ````\n \n```` Requires scope(s): assignment-read or assignment-write ````",
"operationId": "AssignmentsByIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "culture",
"in": "query",
"description": "The culture to return the assignments translated texts.",
"style": "form",
"schema": {
"maxLength": 20,
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.AssignmentDetailsQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.AssignmentDetailsQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.AssignmentDetailsQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.AssignmentDetailsQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.AssignmentDetailsQuery.Result"
}
}
}
}
}
},
"patch": {
"tags": [
"Assignment"
],
"summary": "Patch Assignment Basic Information",
"description": "\r\n\r\n Allows for Json patching to be performed against basic assignment fields.\r\n More information about PATCHING, see https://developer.ontempworks.com/docs/your-request\r\n \r\n\r\n\r\n Valid Patch paths: /AlternateAssignmentId(string), /BurdenTypeId(int?), /TemporaryPhoneNumber(string), /AssignmentStatusId(int), /ReplacesAssignmentId(long?), /CustomerHasBlacklistedEmployee(bool), /EmployeeHasBlacklistedCustomer(bool), /JobTitleId(int), /BusinessCodeId(Guid?), /StartDate(DateTime), /EndDate(DateTime?), /ExpectedEndDate(DateTime?), /OriginalStartDate(DateTime?), /ShiftId(Guid?), /StartTime(string), /EndTime(string), /ShiftNote(string), /IsScheduledForSunday(bool), /IsScheduledForMonday(bool), /IsScheduledForTuesday(bool), /IsScheduledForWednesday(bool), /IsScheduledForThursday(bool), /IsScheduledForFriday(bool), /IsScheduledForSaturday(bool), /WorkerCompCodeId(int), /PayrollNote(string), /PerformanceNote(string), /PurchaseOrderId(int?), /SalesTeamId(int), /BranchId(int), /DoNotAutoClose(bool), /AccountManagerServiceRepId(int?), /ServiceRepId(int?), /IsNonComparable(bool), /ResetsAWRClock(bool), /PrimaryMessageId(long?), /RemoteWorkStatusId(int?)\r\n \n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): assignment-write ````",
"operationId": "AssignmentsByIdPatch",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "A Json array of patch operations to be performed.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":"651-555-1234","path":"/TemporaryPhoneNumber","op":"replace"},{"path":"/TemporaryPhoneNumber","op":"remove"},{"value":"651-555-1234","path":"/TemporaryPhoneNumber","op":"add"},{"path":"/PerformanceNote","op":"copy","from":"/ShiftNote"},{"path":"/PerformanceNote","op":"move","from":"/ShiftNote"},{"value":"651-555-1234","path":"/TemporaryPhoneNumber","op":"test"}]
},
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":"651-555-1234","path":"/TemporaryPhoneNumber","op":"replace"},{"path":"/TemporaryPhoneNumber","op":"remove"},{"value":"651-555-1234","path":"/TemporaryPhoneNumber","op":"add"},{"path":"/PerformanceNote","op":"copy","from":"/ShiftNote"},{"path":"/PerformanceNote","op":"move","from":"/ShiftNote"},{"value":"651-555-1234","path":"/TemporaryPhoneNumber","op":"test"}]
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":"651-555-1234","path":"/TemporaryPhoneNumber","op":"replace"},{"path":"/TemporaryPhoneNumber","op":"remove"},{"value":"651-555-1234","path":"/TemporaryPhoneNumber","op":"add"},{"path":"/PerformanceNote","op":"copy","from":"/ShiftNote"},{"path":"/PerformanceNote","op":"move","from":"/ShiftNote"},{"value":"651-555-1234","path":"/TemporaryPhoneNumber","op":"test"}]
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":"651-555-1234","path":"/TemporaryPhoneNumber","op":"replace"},{"path":"/TemporaryPhoneNumber","op":"remove"},{"value":"651-555-1234","path":"/TemporaryPhoneNumber","op":"add"},{"path":"/PerformanceNote","op":"copy","from":"/ShiftNote"},{"path":"/PerformanceNote","op":"move","from":"/ShiftNote"},{"value":"651-555-1234","path":"/TemporaryPhoneNumber","op":"test"}]
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":"651-555-1234","path":"/TemporaryPhoneNumber","op":"replace"},{"path":"/TemporaryPhoneNumber","op":"remove"},{"value":"651-555-1234","path":"/TemporaryPhoneNumber","op":"add"},{"path":"/PerformanceNote","op":"copy","from":"/ShiftNote"},{"path":"/PerformanceNote","op":"move","from":"/ShiftNote"},{"value":"651-555-1234","path":"/TemporaryPhoneNumber","op":"test"}]
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": "\r\n \r\n \r\n replace\r\n /TemporaryPhoneNumber\r\n 651-555-1234\r\n \r\n \r\n \r\n remove\r\n /TemporaryPhoneNumber\r\n \r\n \r\n \r\n \r\n add\r\n /TemporaryPhoneNumber\r\n 651-555-1234\r\n \r\n \r\n /ShiftNote\r\n copy\r\n /PerformanceNote\r\n \r\n \r\n \r\n /ShiftNote\r\n move\r\n /PerformanceNote\r\n \r\n \r\n \r\n \r\n test\r\n /TemporaryPhoneNumber\r\n 651-555-1234\r\n \r\n"
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": "\r\n \r\n \r\n replace\r\n /TemporaryPhoneNumber\r\n 651-555-1234\r\n \r\n \r\n \r\n remove\r\n /TemporaryPhoneNumber\r\n \r\n \r\n \r\n \r\n add\r\n /TemporaryPhoneNumber\r\n 651-555-1234\r\n \r\n \r\n /ShiftNote\r\n copy\r\n /PerformanceNote\r\n \r\n \r\n \r\n /ShiftNote\r\n move\r\n /PerformanceNote\r\n \r\n \r\n \r\n \r\n test\r\n /TemporaryPhoneNumber\r\n 651-555-1234\r\n \r\n"
},
"application/*+xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": "\r\n \r\n \r\n replace\r\n /TemporaryPhoneNumber\r\n 651-555-1234\r\n \r\n \r\n \r\n remove\r\n /TemporaryPhoneNumber\r\n \r\n \r\n \r\n \r\n add\r\n /TemporaryPhoneNumber\r\n 651-555-1234\r\n \r\n \r\n /ShiftNote\r\n copy\r\n /PerformanceNote\r\n \r\n \r\n \r\n /ShiftNote\r\n move\r\n /PerformanceNote\r\n \r\n \r\n \r\n \r\n test\r\n /TemporaryPhoneNumber\r\n 651-555-1234\r\n \r\n"
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/Assignments/{id}/accruals": {
"get": {
"tags": [
"Assignment"
],
"summary": "Get Assignment Accruals",
"description": "Gets a list of accruals for the specified assignment.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): assignment-read or assignment-write ````",
"operationId": "AssignmentsByIdAccrualsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "ActiveOnly",
"in": "query",
"description": "Limit the results to active only accruals. Defaults to false.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "Skip",
"in": "query",
"description": "Amount of list items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Take",
"in": "query",
"description": "Amount of list items to take. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assignments.Service.Commands.Accruals.AssignmentAccrualsList.Result, Assignments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assignments.Service.Commands.Accruals.AssignmentAccrualsList.Result, Assignments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assignments.Service.Commands.Accruals.AssignmentAccrualsList.Result, Assignments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assignments.Service.Commands.Accruals.AssignmentAccrualsList.Result, Assignments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assignments.Service.Commands.Accruals.AssignmentAccrualsList.Result, Assignments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assignments.Service.Commands.Accruals.AssignmentAccrualsList.Result, Assignments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assignments.Service.Commands.Accruals.AssignmentAccrualsList.Result, Assignments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Assignment"
],
"summary": "Create Assignment Accrual",
"description": "Creates a new accrual for the specified assignment.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): assignment-write ````",
"operationId": "AssignmentsByIdAccrualsPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The accrual to create.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CreateAssignmentAccrualRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CreateAssignmentAccrualRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CreateAssignmentAccrualRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CreateAssignmentAccrualRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CreateAssignmentAccrualRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CreateAssignmentAccrualRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CreateAssignmentAccrualRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CreateAssignmentAccrualRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.Accruals.CreateAssignmentAccrual.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.Accruals.CreateAssignmentAccrual.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.Accruals.CreateAssignmentAccrual.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.Accruals.CreateAssignmentAccrual.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.Accruals.CreateAssignmentAccrual.Result"
}
}
}
}
}
}
},
"/Assignments/{id}/accruals/{assignmentAccrualId}": {
"put": {
"tags": [
"Assignment"
],
"summary": "Update Assignment Accrual",
"description": "Updates an accrual for the specified assignment.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): assignment-write ````",
"operationId": "AssignmentsByIdAccrualsByAssignmentAccrualIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "assignmentAccrualId",
"in": "path",
"description": "The Id of the assignment's accrual.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The accrual to update.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.UpdateAssignmentAccrualRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.UpdateAssignmentAccrualRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.UpdateAssignmentAccrualRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.UpdateAssignmentAccrualRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.UpdateAssignmentAccrualRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.UpdateAssignmentAccrualRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.UpdateAssignmentAccrualRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.UpdateAssignmentAccrualRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
},
"delete": {
"tags": [
"Assignment"
],
"summary": "Delete Assignment Accrual",
"description": "Deletes a specified assignment accrual.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): assignment-write ````",
"operationId": "AssignmentsByIdAccrualsByAssignmentAccrualIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "assignmentAccrualId",
"in": "path",
"description": "The Id of the assignment accrual.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Assignments/{id}/adjustments": {
"get": {
"tags": [
"Assignment"
],
"summary": "Get Adjustments for Assignment.",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): assignment-read or assignment-write ````",
"operationId": "AssignmentsByIdAdjustmentsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Assignment ID",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "Amount of list items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "Amount of list items to take. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assignments.Service.Commands.Adjustments.AssignmentAdjustments.Result, Assignments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assignments.Service.Commands.Adjustments.AssignmentAdjustments.Result, Assignments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assignments.Service.Commands.Adjustments.AssignmentAdjustments.Result, Assignments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assignments.Service.Commands.Adjustments.AssignmentAdjustments.Result, Assignments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assignments.Service.Commands.Adjustments.AssignmentAdjustments.Result, Assignments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assignments.Service.Commands.Adjustments.AssignmentAdjustments.Result, Assignments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assignments.Service.Commands.Adjustments.AssignmentAdjustments.Result, Assignments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Assignment"
],
"summary": "Add Assignment Adjustment",
"description": "Adds an adjustment to an assignment.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): assignment-write ````",
"operationId": "AssignmentsByIdAdjustmentsPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Id of the assignment.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "A model containing the information to create a new assignment adjustment",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CreateAssignmentAdjustmentRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CreateAssignmentAdjustmentRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CreateAssignmentAdjustmentRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CreateAssignmentAdjustmentRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CreateAssignmentAdjustmentRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CreateAssignmentAdjustmentRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CreateAssignmentAdjustmentRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CreateAssignmentAdjustmentRequest"
}
}
}
},
"responses": {
"201": {
"description": "Id of the created assignment adjustment",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.Adjustments.CreateAssignmentAdjustment.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.Adjustments.CreateAssignmentAdjustment.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.Adjustments.CreateAssignmentAdjustment.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.Adjustments.CreateAssignmentAdjustment.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.Adjustments.CreateAssignmentAdjustment.Result"
}
}
}
}
}
}
},
"/Assignments/{id}/adjustments/{assignmentAdjustmentId}": {
"get": {
"tags": [
"Assignment"
],
"summary": "Get Assignment Adjustment details",
"description": "Gets the assignment adjustment details.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): assignment-read or assignment-write ````",
"operationId": "AssignmentsByIdAdjustmentsByAssignmentAdjustmentIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "assignmentAdjustmentId",
"in": "path",
"description": "The Id of the assignment adjustment",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.Adjustments.AssignmentAdjustments.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.Adjustments.AssignmentAdjustments.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.Adjustments.AssignmentAdjustments.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.Adjustments.AssignmentAdjustments.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.Adjustments.AssignmentAdjustments.Result"
}
}
}
}
}
},
"put": {
"tags": [
"Assignment"
],
"summary": "Update Assignment Adjustment",
"description": "Updates an assignment adjustment.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): assignment-write ````",
"operationId": "AssignmentsByIdAdjustmentsByAssignmentAdjustmentIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Id of the assignment.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "assignmentAdjustmentId",
"in": "path",
"description": "The Id of the updated assignment adjustment",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "A model containing the information to update an existing assignment adjustment",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.UpdateAssignmentAdjustmentRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.UpdateAssignmentAdjustmentRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.UpdateAssignmentAdjustmentRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.UpdateAssignmentAdjustmentRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.UpdateAssignmentAdjustmentRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.UpdateAssignmentAdjustmentRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.UpdateAssignmentAdjustmentRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.UpdateAssignmentAdjustmentRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
},
"delete": {
"tags": [
"Assignment"
],
"summary": "Delete Assignment Adjustment",
"description": "Deletes an assignment adjustment.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): assignment-write ````",
"operationId": "AssignmentsByIdAdjustmentsByAssignmentAdjustmentIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Id of the assignment.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "assignmentAdjustmentId",
"in": "path",
"description": "The Id of the deleted assignment adjustment",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Assignments/{id}/adjustments/{assignmentAdjustmentId}/validate": {
"put": {
"tags": [
"Assignment"
],
"summary": "Validates the request model to update an assignment adjustment.",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): assignment-write ````",
"operationId": "AssignmentsByIdAdjustmentsByAssignmentAdjustmentIdValidatePut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Id of the assignment.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "assignmentAdjustmentId",
"in": "path",
"description": "The Id of the updated assignment adjustment",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "A model containing the information to update an existing assignment adjustment",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.UpdateAssignmentAdjustmentRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.UpdateAssignmentAdjustmentRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.UpdateAssignmentAdjustmentRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.UpdateAssignmentAdjustmentRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.UpdateAssignmentAdjustmentRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.UpdateAssignmentAdjustmentRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.UpdateAssignmentAdjustmentRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.UpdateAssignmentAdjustmentRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/Assignments/{id}/adjustments/validate": {
"post": {
"tags": [
"Assignment"
],
"summary": "Validates the request model to add an adjustment to an assignment.",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): assignment-write ````",
"operationId": "AssignmentsByIdAdjustmentsValidatePost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Id of the assignment.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The update request model.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CreateAssignmentAdjustmentRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CreateAssignmentAdjustmentRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CreateAssignmentAdjustmentRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CreateAssignmentAdjustmentRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CreateAssignmentAdjustmentRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CreateAssignmentAdjustmentRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CreateAssignmentAdjustmentRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CreateAssignmentAdjustmentRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/Assignments/{id}/calculateGrossProfit": {
"post": {
"tags": [
"Assignment"
],
"summary": "Calculate Gross Profit for an Assignment",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): assignment-read or assignment-write ````",
"operationId": "AssignmentsByIdCalculateGrossProfitPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "Request Body",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.CalculateGrossProfitRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.CalculateGrossProfitRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.CalculateGrossProfitRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.CalculateGrossProfitRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.CalculateGrossProfitRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.CalculateGrossProfitRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.CalculateGrossProfitRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.CalculateGrossProfitRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.CalculateGrossProfitResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.CalculateGrossProfitResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.CalculateGrossProfitResult"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.CalculateGrossProfitResult"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.CalculateGrossProfitResult"
}
}
}
}
}
}
},
"/Assignments/{id}/commissionAllocation": {
"get": {
"tags": [
"Assignment"
],
"summary": "Get Assignment Commission Allocation List",
"description": "Gets a list of commission allocations entries for the assignment. The list is sorted by credit type then service rep name.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): assignment-read or assignment-write ````",
"operationId": "AssignmentsByIdCommissionAllocationGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of commission allocation records to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of commission allocation records to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assignments.Service.Commands.AssignmentAllocationQuery.Result, Assignments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assignments.Service.Commands.AssignmentAllocationQuery.Result, Assignments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assignments.Service.Commands.AssignmentAllocationQuery.Result, Assignments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assignments.Service.Commands.AssignmentAllocationQuery.Result, Assignments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assignments.Service.Commands.AssignmentAllocationQuery.Result, Assignments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assignments.Service.Commands.AssignmentAllocationQuery.Result, Assignments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assignments.Service.Commands.AssignmentAllocationQuery.Result, Assignments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Assignment"
],
"summary": "Create Assignment Allocation Record",
"description": "Creates an assignment allocation record\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): assignment-write ````",
"operationId": "AssignmentsByIdCommissionAllocationPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The body of the request containing the information to create the commission allocation record",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CommissionAllocation"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CommissionAllocation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CommissionAllocation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CommissionAllocation"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CommissionAllocation"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CommissionAllocation"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CommissionAllocation"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CommissionAllocation"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.CreateAssignmentAllocationCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.CreateAssignmentAllocationCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.CreateAssignmentAllocationCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.CreateAssignmentAllocationCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.CreateAssignmentAllocationCommand.Result"
}
}
}
}
}
}
},
"/Assignments/{id}/commissionAllocation/{allocationsId}": {
"get": {
"tags": [
"Assignment"
],
"summary": "Get Assignment Commission Allocation Record",
"description": "Gets a single commission allocation record with the given allocationsId.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): assignment-read or assignment-write ````",
"operationId": "AssignmentsByIdCommissionAllocationByAllocationsIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "allocationsId",
"in": "path",
"description": "The Id of the commission allocation record",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.AssignmentAllocationQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.AssignmentAllocationQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.AssignmentAllocationQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.AssignmentAllocationQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.AssignmentAllocationQuery.Result"
}
}
}
}
}
},
"put": {
"tags": [
"Assignment"
],
"summary": "Update Assignment Commission Allocation Record",
"description": "Updates the assignment allocation record\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): assignment-write ````",
"operationId": "AssignmentsByIdCommissionAllocationByAllocationsIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "allocationsId",
"in": "path",
"description": "The Id of the commission allocation record to update",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The body of the request containing the information to update the commission allocation record",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CommissionAllocation"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CommissionAllocation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CommissionAllocation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CommissionAllocation"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CommissionAllocation"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CommissionAllocation"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CommissionAllocation"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CommissionAllocation"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
},
"delete": {
"tags": [
"Assignment"
],
"summary": "Delete Assignment Commission Allocation Record",
"description": "Deletes the commission allocation record with the given allocationsId.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): assignment-write ````",
"operationId": "AssignmentsByIdCommissionAllocationByAllocationsIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "allocationsId",
"in": "path",
"description": "The Id of the availability record to delete",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Assignments/{id}/CustomData": {
"get": {
"tags": [
"Assignment"
],
"summary": "Get Custom Data",
"description": "Gets a list of Custom Data Properties for an Assignment.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): assignment-read or assignment-write ````",
"operationId": "AssignmentsByIdCustomDataGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "includeInactiveProperties",
"in": "query",
"description": "When true, any properties that have been marked inactive will also be returned.",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.CustomData.EntityCustomDataQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.CustomData.EntityCustomDataQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.CustomData.EntityCustomDataQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.CustomData.EntityCustomDataQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.CustomData.EntityCustomDataQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.CustomData.EntityCustomDataQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.CustomData.EntityCustomDataQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"put": {
"tags": [
"Assignment"
],
"summary": "Update Custom Data",
"description": "Updates the Custom Data Properties for an Assignment.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): assignment-write ````",
"operationId": "AssignmentsByIdCustomDataPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The list of values to store.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.CustomData.UpdateEntityCustomDataRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.CustomData.UpdateEntityCustomDataRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.CustomData.UpdateEntityCustomDataRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.CustomData.UpdateEntityCustomDataRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.CustomData.UpdateEntityCustomDataRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.CustomData.UpdateEntityCustomDataRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.CustomData.UpdateEntityCustomDataRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.CustomData.UpdateEntityCustomDataRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Assignments/{id}/directHire/financials": {
"get": {
"tags": [
"Assignment"
],
"summary": "Get Direct Hire Financial Details",
"description": "Gets financial information about the assignment of type direct hire.\n \n```` Allows roles: ServiceRep, WebUserEmployee, Service ````\n \n```` Requires scope(s): assignment-read or assignment-write ````",
"operationId": "AssignmentsByIdDirectHireFinancialsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.AssignmentDirectHireFinancials.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.AssignmentDirectHireFinancials.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.AssignmentDirectHireFinancials.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.AssignmentDirectHireFinancials.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.AssignmentDirectHireFinancials.Result"
}
}
}
}
}
},
"put": {
"tags": [
"Assignment"
],
"summary": "Update Financial Details",
"description": "Updates financial details about the assignment, including salary, fee and fee percentage information.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): assignment-write ````",
"operationId": "AssignmentsByIdDirectHireFinancialsPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The request body containing the updated direct hire financial details.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.UpdatedAssignmentDirectHireFinancialsRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.UpdatedAssignmentDirectHireFinancialsRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.UpdatedAssignmentDirectHireFinancialsRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.UpdatedAssignmentDirectHireFinancialsRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.UpdatedAssignmentDirectHireFinancialsRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.UpdatedAssignmentDirectHireFinancialsRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.UpdatedAssignmentDirectHireFinancialsRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.UpdatedAssignmentDirectHireFinancialsRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Assignments/{id}/directHire/placementFees": {
"get": {
"tags": [
"Assignment"
],
"summary": "Get Assignment Direct Hire Placement Fees",
"description": "\n \n```` Allows roles: ServiceRep, WebUserEmployee, Service ````\n \n```` Requires scope(s): assignment-read or assignment-write ````",
"operationId": "AssignmentsByIdDirectHirePlacementFeesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "startDateAfter",
"in": "query",
"description": "Return placement fees with start date after the specified date.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "isActive",
"in": "query",
"description": "Filter placement fees by their active flag.",
"style": "form",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assignments.Service.Commands.AssignmentDirectHirePlacementFees.Result, Assignments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assignments.Service.Commands.AssignmentDirectHirePlacementFees.Result, Assignments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assignments.Service.Commands.AssignmentDirectHirePlacementFees.Result, Assignments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assignments.Service.Commands.AssignmentDirectHirePlacementFees.Result, Assignments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assignments.Service.Commands.AssignmentDirectHirePlacementFees.Result, Assignments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assignments.Service.Commands.AssignmentDirectHirePlacementFees.Result, Assignments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assignments.Service.Commands.AssignmentDirectHirePlacementFees.Result, Assignments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Assignment"
],
"summary": "Create Assignment Direct Hire Placement Fee.",
"description": "Creates a placement fee for an Assignment which job order is of type Direct Hire .\r\nThis endpoint would return 403 Forbidden if you attempt to add information about \r\nan assignment which is created for a job order with type other than 'Direct Hire'. \r\nIn order to determine a job order type you could use endpoint ```GET /jobOrders/{jobOrderId}```.\r\nIn order to change a job order type you could use endpoint ```PATCH /jobOrders/{jobOrderId}```.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): assignment-write ````",
"operationId": "AssignmentsByIdDirectHirePlacementFeesPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The request body containing the needed information to create a placement fee.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CreateAssignmentDirectHirePlacementFeeRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CreateAssignmentDirectHirePlacementFeeRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CreateAssignmentDirectHirePlacementFeeRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CreateAssignmentDirectHirePlacementFeeRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CreateAssignmentDirectHirePlacementFeeRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CreateAssignmentDirectHirePlacementFeeRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CreateAssignmentDirectHirePlacementFeeRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CreateAssignmentDirectHirePlacementFeeRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.CreateAssignmentDirectHirePlacementFee.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.CreateAssignmentDirectHirePlacementFee.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.CreateAssignmentDirectHirePlacementFee.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.CreateAssignmentDirectHirePlacementFee.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.CreateAssignmentDirectHirePlacementFee.Result"
}
}
}
}
}
}
},
"/Assignments/{id}/directHire/placementFees/{placementFeeId}": {
"put": {
"tags": [
"Assignment"
],
"summary": "Update Assignment Direct Hire Placement Fee.",
"description": "Update a placement fee for an Assignment which job order is of type Direct Hire .\r\nThis endpoint would return 403 Forbidden if you attempt to edit information about \r\nan assignment which is created for a job order with type other than 'Direct Hire'. \r\nIn order to determine a job order type you could use endpoint ```GET /jobOrders/{jobOrderId}```.\r\nIn order to change a job order type you could use endpoint ```PATCH /jobOrders/{jobOrderId}```.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): assignment-write ````",
"operationId": "AssignmentsByIdDirectHirePlacementFeesByPlacementFeeIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "placementFeeId",
"in": "path",
"description": "The Id of the placement fee.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The request body containing the needed information to edit a placement fee.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.UpdateAssignmentDirectHirePlacementFeeRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.UpdateAssignmentDirectHirePlacementFeeRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.UpdateAssignmentDirectHirePlacementFeeRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.UpdateAssignmentDirectHirePlacementFeeRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.UpdateAssignmentDirectHirePlacementFeeRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.UpdateAssignmentDirectHirePlacementFeeRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.UpdateAssignmentDirectHirePlacementFeeRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.UpdateAssignmentDirectHirePlacementFeeRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
},
"get": {
"tags": [
"Assignment"
],
"summary": "Get Assignment Direct Hire Placement Fee details.",
"description": "Gets a placement fee details for an Assignment which job order is of type Direct Hire .\r\nThis endpoint would return 403 Forbidden if you attempt to get information about \r\nan assignment which is created for a job order with type other than 'Direct Hire'. \r\nIn order to determine a job order type you could use endpoint ```GET /jobOrders/{jobOrderId}```.\r\nIn order to change a job order type you could use endpoint ```PATCH /jobOrders/{jobOrderId}```.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): assignment-write ````",
"operationId": "AssignmentsByIdDirectHirePlacementFeesByPlacementFeeIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "placementFeeId",
"in": "path",
"description": "The Id of the placement fee.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.AssignmentDirectHirePlacementFeeDetails.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.AssignmentDirectHirePlacementFeeDetails.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.AssignmentDirectHirePlacementFeeDetails.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.AssignmentDirectHirePlacementFeeDetails.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.AssignmentDirectHirePlacementFeeDetails.Result"
}
}
}
}
}
}
},
"/Assignments/{id}/directHire/placementFees/deactivate": {
"put": {
"tags": [
"Assignment"
],
"summary": "Deactivate Assignment Late Direct Hire Placement Fees",
"description": "Deactivates all placement fees that have a StartDate later than the Assignment's EndDate\r\nfor an Assignment which has a Job Order with a direct hire job order type.\r\nThis endpoint would return 403 Forbidden if you attempt to edit information about \r\nan assignment which is created for a job order with type other than the direct hire job order type. \r\nIn order to determine a job order type you could use endpoint ```GET /jobOrders/{jobOrderId}```.\r\nIn order to change a job order type you could use endpoint ```PATCH /jobOrders/{jobOrderId}```.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): assignment-write ````",
"operationId": "AssignmentsByIdDirectHirePlacementFeesDeactivatePut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Assignments/{id}/documents": {
"get": {
"tags": [
"Assignment"
],
"summary": "Get Documents",
"description": "Get a list of documents linked to the assignment.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): assignment-read or assignment-write ````",
"operationId": "AssignmentsByIdDocumentsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of documents to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of documents to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "sortByAscending",
"in": "query",
"description": "true to sort by ASC, defaults to DESC",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "sortBy",
"in": "query",
"description": "Field to sort by, valid fields are \"DocumentType\" and \"DocumentDate\"",
"style": "form",
"schema": {
"type": "string",
"default": "DocumentDate"
}
},
{
"name": "filterByDocumentTypeId",
"in": "query",
"description": "DocumentTypeId to filter by",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Documents.GetEntityDocumentsQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Documents.GetEntityDocumentsQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Documents.GetEntityDocumentsQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Documents.GetEntityDocumentsQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Documents.GetEntityDocumentsQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Documents.GetEntityDocumentsQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Documents.GetEntityDocumentsQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Assignment"
],
"summary": "Upload Document",
"description": "Uploads a document to the assignment. This requires a multipart form-data POST request. \r\nOne part must contain the file to upload and subsequent parts will be used to provide \r\nother data such as documentTypeId.\r\n\r\nFor more information about using formdata, see: https://developer.mozilla.org/en-US/docs/Web/API/FormData/FormData\r\nFor more information about using multimart/form-data, see: http://stackoverflow.com/questions/4526273/what-does-enctype-multipart-form-data-mean\r\nBelow is an example multipart/form-data POST request body:\r\n\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn\r\nContent-Disposition: form-data; name=\"file\"; filename=\"Test.txt\"\r\nContent-Type: text/plain\r\n\r\nThis is where the file content is placed! This is a valid for a text document!\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn\r\nContent-Disposition: form-data; name=\"fileName\"\r\n\r\nNewFileName.txt\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn\r\nContent-Disposition: form-data; name=\"expirationDate\"\r\n\r\n2012-12-21\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn\r\nContent-Disposition: form-data; name=\"documentTypeId\"\r\n\r\n1\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn\r\nContent-Disposition: form-data; name=\"version\"\r\n\r\n1\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn\r\nContent-Disposition: form-data; name=\"description\"\r\n\r\ntest\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn--\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): assignment-write ````",
"operationId": "AssignmentsByIdDocumentsPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"201": {
"description": "Id of the new document",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
}
}
}
}
}
},
"/Assignments/{id}/documents/{documentId}": {
"get": {
"tags": [
"Assignment"
],
"summary": "Get Document Details",
"description": "Gets details about the specified document from the specified assignment.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): assignment-read or assignment-write ````",
"operationId": "AssignmentsByIdDocumentsByDocumentIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "documentId",
"in": "path",
"description": "The Id of the document.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.GetEntityDocumentQuery.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.GetEntityDocumentQuery.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.GetEntityDocumentQuery.Document"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.GetEntityDocumentQuery.Document"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.GetEntityDocumentQuery.Document"
}
}
}
}
}
},
"put": {
"tags": [
"Assignment"
],
"summary": "Update Document Details",
"description": "Updates detail information about the document.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): assignment-write ````",
"operationId": "AssignmentsByIdDocumentsByDocumentIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "documentId",
"in": "path",
"description": "The Id of the document.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The body of the request containing the updated details information.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Documents.UpdateEntityDocumentDetailsRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Documents.UpdateEntityDocumentDetailsRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Documents.UpdateEntityDocumentDetailsRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Documents.UpdateEntityDocumentDetailsRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Documents.UpdateEntityDocumentDetailsRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Documents.UpdateEntityDocumentDetailsRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Documents.UpdateEntityDocumentDetailsRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Documents.UpdateEntityDocumentDetailsRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
},
"delete": {
"tags": [
"Assignment"
],
"summary": "Delete Document",
"description": "Deletes the specified document.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): assignment-write ````",
"operationId": "AssignmentsByIdDocumentsByDocumentIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "documentId",
"in": "path",
"description": "The Id of the document.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Assignments/{id}/documents/{documentId}/bytes": {
"get": {
"tags": [
"Assignment"
],
"summary": "Get Document",
"description": "Gets the specified document from the specified assignment.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): assignment-read or assignment-write ````",
"operationId": "AssignmentsByIdDocumentsByDocumentIdBytesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "documentId",
"in": "path",
"description": "The Id of the document.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "returnPdf",
"in": "query",
"description": "Used to indicated whether or not a PDF should be returned if the file is convertable to PDF",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "string",
"format": "byte"
}
},
"text/csv": {
"schema": {
"type": "string",
"format": "byte"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"type": "string",
"format": "byte"
}
},
"application/json": {
"schema": {
"type": "string",
"format": "byte"
}
},
"text/json": {
"schema": {
"type": "string",
"format": "byte"
}
},
"application/xml": {
"schema": {
"type": "string",
"format": "byte"
}
},
"text/xml": {
"schema": {
"type": "string",
"format": "byte"
}
}
}
}
}
}
},
"/Assignments/{id}/documents/metadata": {
"get": {
"tags": [
"Assignment"
],
"summary": "Get Documents Metadata",
"description": "Returns information about document creation restrictions.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): assignment-read or assignment-write ````",
"operationId": "AssignmentsByIdDocumentsMetadataGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.DocumentMetadataQuery.Metadata"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.DocumentMetadataQuery.Metadata"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.DocumentMetadataQuery.Metadata"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.DocumentMetadataQuery.Metadata"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.DocumentMetadataQuery.Metadata"
}
}
}
}
}
}
},
"/Assignments/{id}/extend": {
"post": {
"tags": [
"Assignment"
],
"summary": "Extend Assignment",
"description": "Closes the assignment and creates a new assignment. This is to be used when there is a rate change or an extension to the current assignment. \r\nThe assignment performance code will be set to the performance code configured in the system with the IsRateChange property = true.\r\nClients may customize this process by setting the following configuration values: \r\n CustomProcAfterExtendAssignment - Adds additional logic to the existing process. This logic runs after the extend assignment process has completed and is the recommended configuration for alterations to the process.\r\n CopyAssignmentAdjs - When true, the assignment adjustments are copied when extend assignment is used. The CopyAssignmentAdjustments parameter may be used to override this configuration.\r\n CopyAsgCustomDataInExtendAssignment - When true, the assignment custom data values are copied when extend assignment is used. The CopyAssignmentCustomData parameter may be used to override this configuration.\r\n CustomExtendAssignProc - Obsolete. This configuration is for backwards compatibility only. This configuration completely replaces the extend assignment process. This should only be used when all other configurations are not applicable.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): assignment-write ````",
"operationId": "AssignmentsByIdExtendPost",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.ExtendAssignmentRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.ExtendAssignmentRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.ExtendAssignmentRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.ExtendAssignmentRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.ExtendAssignmentRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.ExtendAssignmentRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.ExtendAssignmentRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.ExtendAssignmentRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.ExtendAssignment.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.ExtendAssignment.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.ExtendAssignment.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.ExtendAssignment.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.ExtendAssignment.Result"
}
}
}
}
}
}
},
"/Assignments/{id}/financials": {
"get": {
"tags": [
"Assignment"
],
"summary": "Get Financial Details",
"description": "Gets financial information about the assignment including pay and bill information.\n \n```` Allows roles: ServiceRep, WebUserEmployee, Service ````\n \n```` Requires scope(s): assignment-read or assignment-write ````",
"operationId": "AssignmentsByIdFinancialsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.AssignmentFinancialsQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.AssignmentFinancialsQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.AssignmentFinancialsQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.AssignmentFinancialsQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.AssignmentFinancialsQuery.Result"
}
}
}
}
}
},
"put": {
"tags": [
"Assignment"
],
"summary": "Update Financial Details",
"description": "Updates financial details about the assignment, including pay and bill information.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): assignment-write ````",
"operationId": "AssignmentsByIdFinancialsPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The request body containing the updated financial details.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.UpdatedAssignmentFinancialsRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.UpdatedAssignmentFinancialsRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.UpdatedAssignmentFinancialsRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.UpdatedAssignmentFinancialsRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.UpdatedAssignmentFinancialsRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.UpdatedAssignmentFinancialsRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.UpdatedAssignmentFinancialsRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.UpdatedAssignmentFinancialsRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Assignments/{id}/ics": {
"get": {
"tags": [
"Assignment"
],
"summary": "Get iCal file for this assignment",
"description": "Gets an iCal file with scheduling information and details from this assignment.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): assignment-read or assignment-write ````",
"operationId": "AssignmentsByIdIcsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "string",
"format": "byte"
}
},
"text/csv": {
"schema": {
"type": "string",
"format": "byte"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"type": "string",
"format": "byte"
}
},
"application/json": {
"schema": {
"type": "string",
"format": "byte"
}
},
"text/json": {
"schema": {
"type": "string",
"format": "byte"
}
},
"application/xml": {
"schema": {
"type": "string",
"format": "byte"
}
},
"text/xml": {
"schema": {
"type": "string",
"format": "byte"
}
}
}
}
}
}
},
"/Assignments/{id}/jobDetails": {
"get": {
"tags": [
"Assignment"
],
"summary": "Get Job Details",
"description": "Gets information about the job including schedule and location.\n \n```` Allows roles: ServiceRep, WebUserEmployee, Service ````\n \n```` Requires scope(s): assignment-read or assignment-write ````",
"operationId": "AssignmentsByIdJobDetailsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "culture",
"in": "query",
"description": "The culture to return the assignment job details translated texts.",
"style": "form",
"schema": {
"maxLength": 20,
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Assignments.AssignmentJobDetails.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Assignments.AssignmentJobDetails.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Assignments.AssignmentJobDetails.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Assignments.AssignmentJobDetails.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Assignments.AssignmentJobDetails.Result"
}
}
}
}
}
}
},
"/Assignments/{id}/MatchingRateSheets": {
"get": {
"tags": [
"Assignment"
],
"summary": "Gets a list of rate sheets that are applicable to this assignment,\r\nconsidering its EmployeeId, CompanyId, CustomerId, WorksiteId, JobTitleId, BranchId, and ShiftId.",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): assignment-read or assignment-write ````",
"operationId": "AssignmentsByIdMatchingRateSheetsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "JobTitleIdOverride",
"in": "query",
"description": "If provided, returned Rate Sheets will be matched against this JobTitleIdOverride\r\ninstead of the JobTitleId on the Assignment.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "DoNotMatchOnJobTitleId",
"in": "query",
"description": "If provided, will set the JobTitleIdOverride to a value that doesn't exist in the database",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "WorksiteIdOverride",
"in": "query",
"description": "If provided, returned Rate Sheets will be matched against this WorksiteIdOverride\r\ninstead of the WorksiteId on the Assignment.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "DoNotMatchOnWorksiteId",
"in": "query",
"description": "If provided, will set the WorksiteIdOverride to a value that doesn't exist in the database",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "ShiftIdOverride",
"in": "query",
"description": "If provided, returned Rate Sheets will be matched against this ShiftIdOverride\r\ninstead of the ShiftId on the Assignment.",
"style": "form",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "DoNotMatchOnShiftId",
"in": "query",
"description": "If provided, will set the ShiftIdOverride to a value that doesn't exist in the database",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "BranchIdOverride",
"in": "query",
"description": "If provided, returned Rate Sheets will be matched against this BranchIdOverride\r\ninstead of the BranchId on the Assignment.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "DoNotMatchOnBranchId",
"in": "query",
"description": "If provided, will set the BranchIdOverride to a value that doesn't exist in the database",
"style": "form",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.AssignmentMatchingRateSheets.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.AssignmentMatchingRateSheets.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.AssignmentMatchingRateSheets.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.AssignmentMatchingRateSheets.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.AssignmentMatchingRateSheets.Result"
}
}
}
}
}
}
},
"/Assignments/{id}/messages": {
"get": {
"tags": [
"Assignment"
],
"summary": "Get Messages",
"description": "Gets a list of messages linked to the Assignment. The Messages are ordered from newest to the oldest.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): assignment-read or assignment-write ````",
"operationId": "AssignmentsByIdMessagesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of messages to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of messages to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "messageActionId",
"in": "query",
"description": "Optional filter on the Id of the message action. Valid values can be found in the Message Action List. ref: /datalists/messageactions",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "messageActionTypeId",
"in": "query",
"description": "Optional filter on the Id of the message action type. Valid values can be found in the Message Action Type List. ref: /datalists/messageactiontypes",
"style": "form",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "authorSrIdent",
"in": "query",
"description": "Optional filter on the Id of the Service Rep who created the message.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "startDate",
"in": "query",
"description": "Optional filter on the date of the message. Any messages created on or after the date supplied will be returned.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "endDate",
"in": "query",
"description": "Optional filter on the date of the message. Any messages created on or before the date supplied will be returned.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "orderBy",
"in": "query",
"description": "Optional parameter to specify the column to order by. Valid values are 'date', 'action', 'actiondescription','authorsrident','author','id', and 'message', Defaults to 'date'",
"style": "form",
"schema": {
"maxLength": 150,
"minLength": 0,
"type": "string"
}
},
{
"name": "orderByAscending",
"in": "query",
"description": "Optional parameter to specify the direction to order by. Specify true to order ascending.",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "messageText",
"in": "query",
"description": "Optional parameter to search on the message text. To search for any message which contains a word which starts with accep, the value would be: accep*",
"style": "form",
"schema": {
"maxLength": 1000,
"minLength": 0,
"type": "string"
}
},
{
"name": "limitToPrimaryMessages",
"in": "query",
"description": "Set to true to only return the primary messages. Currently only one primary message is supported. \r\n This can be set using the endpoint PATCH assignments/{id} and setting the value PrimaryMessageId.\r\n Optional filters such as start date and end date are ignored when this value is true.",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Assignment"
],
"summary": "Create Message",
"description": "Creates a message and links it to the assignment.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): assignment-read or assignment-write ````",
"operationId": "AssignmentsByIdMessagesPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The body of the request containing the information required to create the message.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateMessageWithLinkedDocumentsRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateMessageWithLinkedDocumentsRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateMessageWithLinkedDocumentsRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateMessageWithLinkedDocumentsRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateMessageWithLinkedDocumentsRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateMessageWithLinkedDocumentsRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateMessageWithLinkedDocumentsRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateMessageWithLinkedDocumentsRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
}
}
}
}
}
},
"/Assignments/{id}/messages/{messageId}": {
"get": {
"tags": [
"Assignment"
],
"summary": "Gets the details of a specific message.",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): assignment-read or assignment-write ````",
"operationId": "AssignmentsByIdMessagesByMessageIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "messageId",
"in": "path",
"description": "The Id of the message.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageDetails"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageDetails"
}
}
}
}
}
}
},
"/Assignments/{id}/messages/relatedEntities": {
"get": {
"tags": [
"Assignment"
],
"summary": "Gets the specified assignment`s related entities.",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): assignment-read or assignment-write ````",
"operationId": "AssignmentsByIdMessagesRelatedEntitiesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the assignment.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageLink"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageLink"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageLink"
}
}
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageLink"
}
}
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageLink"
}
}
}
}
}
}
}
},
"/Assignments/{id}/Status": {
"post": {
"tags": [
"Assignment"
],
"summary": "Update Assignment Status",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): assignment-write ````",
"operationId": "AssignmentsByIdStatusPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The details of the status change.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.StatusChange.StatusChangeApiRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.StatusChange.StatusChangeApiRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.StatusChange.StatusChangeApiRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.StatusChange.StatusChangeApiRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.StatusChange.StatusChangeApiRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.StatusChange.StatusChangeApiRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.StatusChange.StatusChangeApiRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.StatusChange.StatusChangeApiRequest"
}
}
}
},
"responses": {
"200": {
"description": "Status Changed.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.AssignmentStatusUpdateCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.AssignmentStatusUpdateCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.AssignmentStatusUpdateCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.AssignmentStatusUpdateCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.AssignmentStatusUpdateCommand.Result"
}
}
}
},
"202": {
"description": "Status Changed and Additional Actions are staged for execution or had errors that require additional attention.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.AssignmentStatusUpdateCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.AssignmentStatusUpdateCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.AssignmentStatusUpdateCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.AssignmentStatusUpdateCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.AssignmentStatusUpdateCommand.Result"
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/Assignments/{id}/Status/{newAssignmentStatusId}/metadata": {
"get": {
"tags": [
"Assignment"
],
"summary": "Get Assignment Status Change Metadata",
"description": "Returns the metadata regarding the status change for an Assignment. \r\n This includes information regarding the additional actions, validation, and the current state of the prerequisites for the status change.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): assignment-read or assignment-write ````",
"operationId": "AssignmentsByIdStatusByNewAssignmentStatusIdMetadataGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "newAssignmentStatusId",
"in": "path",
"description": "The Id of the new assignment status.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "returnAllPrerequisites",
"in": "query",
"description": "When true, all dynamic validation results are returned regardless of error or not. \r\n When false, only the prerequisites that have had errors are returned. Defaults to false.",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "returnAllAdditionalActions",
"in": "query",
"description": "When true, both required and optional additional actions are returned. \r\n When false, only additional actions that are optional are returned. Defaults to true.",
"style": "form",
"schema": {
"type": "boolean",
"default": true
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.StatusChange.OriginStatusChangeMetadataQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.StatusChange.OriginStatusChangeMetadataQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.StatusChange.OriginStatusChangeMetadataQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.StatusChange.OriginStatusChangeMetadataQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.StatusChange.OriginStatusChangeMetadataQuery.Result"
}
}
}
}
}
}
},
"/Assignments/{id}/summary": {
"get": {
"tags": [
"Assignment"
],
"summary": "Get Summary",
"description": "Gets summary information about the specified assignment.\n \n```` Allows roles: ServiceRep, WebUserEmployee, Service ````\n \n```` Requires scope(s): assignment-read or assignment-write ````",
"operationId": "AssignmentsByIdSummaryGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "culture",
"in": "query",
"description": "The culture to return the assignments translated texts.",
"style": "form",
"schema": {
"maxLength": 20,
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.AssignmentSummaryQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.AssignmentSummaryQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.AssignmentSummaryQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.AssignmentSummaryQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.AssignmentSummaryQuery.Result"
}
}
}
}
}
}
},
"/Assignments/{id}/tasks": {
"get": {
"tags": [
"Assignment"
],
"summary": "Get Assignment Tasks",
"description": "Returns the list of tasks linked to the assignment and belonging to the current user.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): (assignment-read or assignment-write) and (task-read or task-write) ````",
"operationId": "AssignmentsByIdTasksGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "TaskQueryType",
"in": "query",
"required": true,
"style": "form",
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Enums.TaskQueryTypes"
}
},
{
"name": "Skip",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Take",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "StartDueDate",
"in": "query",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "EndDueDate",
"in": "query",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "Priority",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "IncludeNullDueDates",
"in": "query",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "FilterText",
"in": "query",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "AssignedToServiceRepId",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "TeamId",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "CreatedByServiceRepId",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "IsPinned",
"in": "query",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "StartDateArchived",
"in": "query",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "EndDateArchived",
"in": "query",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "OrderBy",
"in": "query",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "OrderByAscending",
"in": "query",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "Tags",
"in": "query",
"style": "form",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Tasks.TaskListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Tasks.TaskListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Tasks.TaskListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Tasks.TaskListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Tasks.TaskListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Tasks.TaskListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Tasks.TaskListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Assignment"
],
"summary": "Create Assignment Task",
"description": "Creates a task and links it to the assignment.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): assignment-write and task-write ````",
"operationId": "AssignmentsByIdTasksPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The body of the request containing the information required to create the task.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateTaskRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateTaskRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateTaskRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateTaskRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateTaskRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateTaskRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateTaskRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateTaskRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.CreateTaskCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.CreateTaskCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.CreateTaskCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.CreateTaskCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.CreateTaskCommand.Result"
}
}
}
}
}
}
},
"/Assignments/{id}/tasks/{taskId}": {
"get": {
"tags": [
"Assignment"
],
"summary": "Get Assignment Task Details",
"description": "Gets more detailed information about a task pertaining to the assignment.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): (assignment-read or assignment-write) and (task-read or task-write) ````",
"operationId": "AssignmentsByIdTasksByTaskIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.TaskDetailsQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.TaskDetailsQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.TaskDetailsQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.TaskDetailsQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.TaskDetailsQuery.Result"
}
}
}
}
}
},
"put": {
"tags": [
"Assignment"
],
"summary": "Update Assignment Task",
"description": "Updates a task linked to the assignment.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): assignment-write and task-write ````",
"operationId": "AssignmentsByIdTasksByTaskIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The body of the request containing the updated task details.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateEntityTaskRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateEntityTaskRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateEntityTaskRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateEntityTaskRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateEntityTaskRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateEntityTaskRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateEntityTaskRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateEntityTaskRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Assignments/{id}/tasks/{taskId}/archive": {
"put": {
"tags": [
"Assignment"
],
"summary": "Archive Assignment Task",
"description": "Archives the task linked to the assignment.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): assignment-write and task-write ````",
"operationId": "AssignmentsByIdTasksByTaskIdArchivePut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Assignments/{id}/tasks/{taskId}/assign": {
"put": {
"tags": [
"Assignment"
],
"summary": "Assign Assignment Task",
"description": "Assigns the task linked to the assignment.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): task-write ````",
"operationId": "AssignmentsByIdTasksByTaskIdAssignPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The body of the request containing the new assignment details for the task.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Assignments/{id}/tasks/{taskId}/messages": {
"get": {
"tags": [
"Assignment"
],
"summary": "Get Assignment Task Messages List",
"description": "Returns the list of messages linked to the task.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): task-read or task-write ````",
"operationId": "AssignmentsByIdTasksByTaskIdMessagesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Assignment"
],
"summary": "Create Assignment Task Message",
"description": "Creates a message and links it to the Task as well as any related Entities.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): task-read or task-write ````",
"operationId": "AssignmentsByIdTasksByTaskIdMessagesPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The body of the message containing the new message details.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.CreateEntityTaskMessageCommand.Command"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.CreateEntityTaskMessageCommand.Command"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.CreateEntityTaskMessageCommand.Command"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.CreateEntityTaskMessageCommand.Command"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.CreateEntityTaskMessageCommand.Command"
}
}
}
}
}
}
},
"/Assignments/{id}/tasks/{taskId}/messages/{messageId}": {
"get": {
"tags": [
"Assignment"
],
"summary": "Get Assignment Task Message Details",
"description": "Returns details about the message.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): task-read or task-write ````",
"operationId": "AssignmentsByIdTasksByTaskIdMessagesByMessageIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "messageId",
"in": "path",
"description": "The Id of the message.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageSummary"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageSummary"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageSummary"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageSummary"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageSummary"
}
}
}
}
}
}
},
"/Assignments/{id}/tasks/{taskId}/pin": {
"put": {
"tags": [
"Assignment"
],
"summary": "Pin Assignment Task",
"description": "Pins the task linked to the assignment.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): assignment-write and task-write ````",
"operationId": "AssignmentsByIdTasksByTaskIdPinPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Assignments/{id}/tasks/{taskId}/unarchive": {
"put": {
"tags": [
"Assignment"
],
"summary": "Unarchive Assignment Task",
"description": "Unarchives the task linked to the assignment.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): assignment-write and task-write ````",
"operationId": "AssignmentsByIdTasksByTaskIdUnarchivePut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Assignments/{id}/tasks/{taskId}/unpin": {
"put": {
"tags": [
"Assignment"
],
"summary": "Unpin Assignment Task",
"description": "Unpins the task linked to the assignment.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): assignment-write and task-write ````",
"operationId": "AssignmentsByIdTasksByTaskIdUnpinPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Assignments/{id}/timeclock": {
"get": {
"tags": [
"Assignment"
],
"summary": "Get Assignment Timeclock Details",
"description": "Gets details about the timeclock configurations for the assignment.\n \n```` Allows roles: ServiceRep, WebUserEmployee, Service ````\n \n```` Requires scope(s): assignment-read or assignment-write ````",
"operationId": "AssignmentsByIdTimeclockGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Timeclock.TimeclockDetailsSettingsModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Timeclock.TimeclockDetailsSettingsModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Timeclock.TimeclockDetailsSettingsModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Timeclock.TimeclockDetailsSettingsModel"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Timeclock.TimeclockDetailsSettingsModel"
}
}
}
}
}
}
},
"/Assignments/{id}/timeclock/costCodes": {
"get": {
"tags": [
"Assignment"
],
"summary": "Get Assignment Timeclock Cost Codes",
"description": "Gets a list of cost codes for the specified assignment. These cost codes are valid cost codes for use when punching into an\r\nassignment. The fact that data comes back from this endpoint does not mean that the assignment is configured for timeclock use or eligible\r\nto be punched currently.\n \n```` Allows roles: ServiceRep, WebUserEmployee, Service ````\n \n```` Requires scope(s): assignment-read or assignment-write ````",
"operationId": "AssignmentsByIdTimeclockCostCodesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Timeclock.CustomerTimeclockCostCodeList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Timeclock.CustomerTimeclockCostCodeList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Timeclock.CustomerTimeclockCostCodeList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Timeclock.CustomerTimeclockCostCodeList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Timeclock.CustomerTimeclockCostCodeList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Timeclock.CustomerTimeclockCostCodeList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Timeclock.CustomerTimeclockCostCodeList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Assignments/{id}/timeclock/payCodes": {
"get": {
"tags": [
"Assignment"
],
"summary": "Get Assignment Timeclock Pay Codes",
"description": "Gets a list of cost codes for the specified assignment. These pay codes are valid pay codes for use when punching into an\r\nassignment. The fact that data comes back from this endpoint does not mean that the assignment is configured for timeclock use or eligible\r\nto be punched currently.\n \n```` Allows roles: ServiceRep, WebUserEmployee, Service ````\n \n```` Requires scope(s): assignment-read or assignment-write ````",
"operationId": "AssignmentsByIdTimeclockPayCodesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Timeclock.CustomerTimeclockPayCodeList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Timeclock.CustomerTimeclockPayCodeList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Timeclock.CustomerTimeclockPayCodeList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Timeclock.CustomerTimeclockPayCodeList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Timeclock.CustomerTimeclockPayCodeList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Timeclock.CustomerTimeclockPayCodeList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Timeclock.CustomerTimeclockPayCodeList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Assignments/{id}/timeclock/punches": {
"get": {
"tags": [
"Assignment"
],
"summary": "Get Assignment Timeclock Punches",
"description": "Gets a list of past punches for the specified assignment. The list is ordered from newest to oldest.\n \n```` Allows roles: ServiceRep, WebUserEmployee, Service ````\n \n```` Requires scope(s): assignment-read or assignment-write ````",
"operationId": "AssignmentsByIdTimeclockPunchesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Assignments.AssignmentTimeclockPunchList.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Assignments.AssignmentTimeclockPunchList.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Assignments.AssignmentTimeclockPunchList.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Assignments.AssignmentTimeclockPunchList.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Assignments.AssignmentTimeclockPunchList.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Assignments.AssignmentTimeclockPunchList.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Assignments.AssignmentTimeclockPunchList.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Assignment"
],
"summary": "Create Assignment Timeclock Punch",
"description": "Creates a punch for the assignment if able. See assignments/{id}/timeclock for details about the current timeclock configuration for the assignment.\n \n```` Allows roles: ServiceRep, WebUserEmployee, Service ````\n \n```` Requires scope(s): assignment-write ````",
"operationId": "AssignmentsByIdTimeclockPunchesPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The request body containing information about the new punch",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CreateTimeclockPunchRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CreateTimeclockPunchRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CreateTimeclockPunchRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CreateTimeclockPunchRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CreateTimeclockPunchRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CreateTimeclockPunchRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CreateTimeclockPunchRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.API.Models.CreateTimeclockPunchRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Timeclock.TimeclockPunchMessageData.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Timeclock.TimeclockPunchMessageData.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Timeclock.TimeclockPunchMessageData.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Timeclock.TimeclockPunchMessageData.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Timeclock.TimeclockPunchMessageData.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Timeclock.TimeclockPunchMessageData.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Timeclock.TimeclockPunchMessageData.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Assignments/{id}/timeclock/punches/{punchId}": {
"get": {
"tags": [
"Assignment"
],
"summary": "Get Assignment Timeclock Punch",
"description": "Gets the punch for the assignment.\n \n```` Allows roles: ServiceRep, WebUserEmployee, Service ````\n \n```` Requires scope(s): assignment-read or assignment-write ````",
"operationId": "AssignmentsByIdTimeclockPunchesByPunchIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "punchId",
"in": "path",
"description": "The Id of the punch",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Assignments.AssignmentTimeclockPunchList.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Assignments.AssignmentTimeclockPunchList.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Assignments.AssignmentTimeclockPunchList.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Assignments.AssignmentTimeclockPunchList.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Assignments.AssignmentTimeclockPunchList.Result"
}
}
}
}
}
}
},
"/Assignments/{id}/timeclock/punchesByDay": {
"get": {
"tags": [
"Assignment"
],
"summary": "Get Assignment Timeclock Punches Grouped by Day",
"description": "Gets a list of past punches for the specified assignment grouped by local punch time day(based on the local punch time). The list is ordered from the most recent to least recent day.\n \n```` Allows roles: ServiceRep, WebUserEmployee, Service ````\n \n```` Requires scope(s): timeclock-read ````",
"operationId": "AssignmentsByIdTimeclockPunchesByDayGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "startDate",
"in": "query",
"description": "Start date filter on the punch day(based on the local punch time). Any punch created on or after the date supplied will be returned.",
"required": true,
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "endDate",
"in": "query",
"description": "End date filter on the punch day(based on the local punch time). Any punch created before the date supplied will be returned.",
"required": true,
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "payCodeId",
"in": "query",
"description": "Optional pay code Id filter on the punch pay code Id. If supplied, any punch having the supplied pay code Id will be returned. \r\nOtherwise, all punches would be returned regardless their associated pay code Id.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "costCode",
"in": "query",
"description": "Optional cost code filter on the punch cost code. If supplied, any punch that have the given cost code or does not have associated cost code will be returned. \r\nOtherwise, all punches would be returned regardless their associated cost code.",
"style": "form",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Messages.Timeclock.PunchListByDayQuery.Result"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Messages.Timeclock.PunchListByDayQuery.Result"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Messages.Timeclock.PunchListByDayQuery.Result"
}
}
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Messages.Timeclock.PunchListByDayQuery.Result"
}
}
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Messages.Timeclock.PunchListByDayQuery.Result"
}
}
}
}
}
}
}
},
"/Assignments/{id}/timeclock/punchLocations": {
"get": {
"tags": [
"Assignment"
],
"summary": "Get Assignment Timeclock Punch Locations",
"description": "Gets a list of punch locations for the specified assignment. These punch locations are valid places for employees to punch in or out\r\nusing the TempWorks mobile application. The fact that data comes back from this endpoint does not mean that the assignment is configured for\r\ntimeclock use or eligible to be punched currently.\n \n```` Allows roles: ServiceRep, WebUserEmployee, Service ````\n \n```` Requires scope(s): assignment-read or assignment-write ````",
"operationId": "AssignmentsByIdTimeclockPunchLocationsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the assignment",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Timeclock.PunchLocationList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Timeclock.PunchLocationList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Timeclock.PunchLocationList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Timeclock.PunchLocationList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Timeclock.PunchLocationList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Timeclock.PunchLocationList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Timeclock.PunchLocationList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/BackgroundChecks": {
"get": {
"tags": [
"BackgroundChecks"
],
"summary": "Get Background Checks",
"description": "Returns a list of Background Checks Ordered by the Date Created Descending.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): backgroundcheck-read or backgroundcheck-write ````",
"operationId": "BackgroundChecksGet",
"parameters": [
{
"name": "EmployeeId",
"in": "query",
"description": "Optional filter on the Id of the employee.",
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "BackgroundCheckId",
"in": "query",
"description": "Optional filter on the Id of the background check.",
"style": "form",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "FirstName",
"in": "query",
"description": "Optional filter on the first name of the employee.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "LastName",
"in": "query",
"description": "Optional filter on the last name of the employee.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "GovernmentPersonalId",
"in": "query",
"description": "Optional filter on the government personal Id.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "BackgroundCheckVendorId",
"in": "query",
"description": "Optional filter on the Id of background check vendor.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "BackgroundCheckStatusId",
"in": "query",
"description": "Optional filter on the background check status.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "CreatedByServiceRepId",
"in": "query",
"description": "Optional filter on the Id of the service rep who created the background check request.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "BranchId",
"in": "query",
"description": "Optional filter on the Id of the employee branch.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "IsReviewed",
"in": "query",
"description": "Optional filter used to filter out background checks which are reviewed.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "OrderBy",
"in": "query",
"description": "Criteria to allow for the control of the Order by Column. Use the column name of the results to locate available fields.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "OrderByAscending",
"in": "query",
"description": "Criteria to allow for the direction of the Order by Column.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "Skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Take",
"in": "query",
"description": "The number of items to take. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.BackgroundChecks.BackgroundChecksSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.BackgroundChecks.BackgroundChecksSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.BackgroundChecks.BackgroundChecksSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.BackgroundChecks.BackgroundChecksSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.BackgroundChecks.BackgroundChecksSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.BackgroundChecks.BackgroundChecksSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.BackgroundChecks.BackgroundChecksSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/BackgroundChecks/{id}": {
"get": {
"tags": [
"BackgroundChecks"
],
"summary": "Get Background Check Details",
"description": "Returns the details for a background check.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): backgroundcheck-read or backgroundcheck-write ````",
"operationId": "BackgroundChecksByIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.BackgroundChecks.BackgroundChecksSearch.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.BackgroundChecks.BackgroundChecksSearch.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.BackgroundChecks.BackgroundChecksSearch.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.BackgroundChecks.BackgroundChecksSearch.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.BackgroundChecks.BackgroundChecksSearch.Result"
}
}
}
}
}
}
},
"/BackgroundChecks/{id}/notReviewed": {
"post": {
"tags": [
"BackgroundChecks"
],
"summary": "Mark a background check status as not reviewed",
"description": "This will set the isReviewed to false and null out the reviewedByServiceRepId\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): backgroundcheck-write ````",
"operationId": "BackgroundChecksByIdNotReviewedPost",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/BackgroundChecks/{id}/reportLocation": {
"get": {
"tags": [
"BackgroundChecks"
],
"summary": "Get Background Check Report Location",
"description": "Returns the report location for a background check. \r\nThis should be called when the background check property of IsReportLocationGeneratedOnDemand is true.\r\nIf the background check vendor is Asurint, this will return a Url which may be used only one time.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): backgroundcheck-read or backgroundcheck-write ````",
"operationId": "BackgroundChecksByIdReportLocationGet",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Common.BackgroundCheckReportLocation.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Common.BackgroundCheckReportLocation.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Common.BackgroundCheckReportLocation.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Common.BackgroundCheckReportLocation.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Common.BackgroundCheckReportLocation.Result"
}
}
}
}
}
}
},
"/BackgroundChecks/{id}/reviewed": {
"post": {
"tags": [
"BackgroundChecks"
],
"summary": "Mark a background check status as reviewed",
"description": "This will set the isReviewed to true and update the reviewedByServiceRepId\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): backgroundcheck-write ````",
"operationId": "BackgroundChecksByIdReviewedPost",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/BackgroundChecks/datalists/customdatafields": {
"get": {
"tags": [
"BackgroundChecks"
],
"summary": "Get Custom Data Fields for Background Check Orders",
"description": "Returns a list of fields which can be included with the background check order.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): backgroundcheck-read or backgroundcheck-write ````",
"operationId": "BackgroundChecksDatalistsCustomdatafieldsGet",
"parameters": [
{
"name": "backgroundCheckVendorId",
"in": "query",
"description": "Required filter on the background check vendor.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "employeeId",
"in": "query",
"description": "When supplied, this is used to limit the values in any properties with a datalist defined or set default values.",
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Commands.BackgroundCheckVendorCustomDataFields.Result, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Commands.BackgroundCheckVendorCustomDataFields.Result, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Commands.BackgroundCheckVendorCustomDataFields.Result, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Commands.BackgroundCheckVendorCustomDataFields.Result, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Commands.BackgroundCheckVendorCustomDataFields.Result, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Commands.BackgroundCheckVendorCustomDataFields.Result, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Commands.BackgroundCheckVendorCustomDataFields.Result, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/BackgroundChecks/datalists/packages": {
"get": {
"tags": [
"BackgroundChecks"
],
"summary": "Get Packages",
"description": "Returns a list of Packages ordered by the package name.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): backgroundcheck-read or backgroundcheck-write ````",
"operationId": "BackgroundChecksDatalistsPackagesGet",
"parameters": [
{
"name": "backgroundCheckVendorId",
"in": "query",
"description": "Optional filter on the background check vendor Id.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Commands.Packages.PackageResult, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Commands.Packages.PackageResult, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Commands.Packages.PackageResult, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Commands.Packages.PackageResult, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Commands.Packages.PackageResult, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Commands.Packages.PackageResult, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Commands.Packages.PackageResult, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/BackgroundChecks/datalists/screenings": {
"get": {
"tags": [
"BackgroundChecks"
],
"summary": "Get Screenings",
"description": "Returns a list of Background screenings ordered by the screening name.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): backgroundcheck-read or backgroundcheck-write ````",
"operationId": "BackgroundChecksDatalistsScreeningsGet",
"parameters": [
{
"name": "backgroundCheckVendorId",
"in": "query",
"description": "Optional filter on the background check vendor Id.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Commands.Screenings.ScreeningResult, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Commands.Screenings.ScreeningResult, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Commands.Screenings.ScreeningResult, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Commands.Screenings.ScreeningResult, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Commands.Screenings.ScreeningResult, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Commands.Screenings.ScreeningResult, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Commands.Screenings.ScreeningResult, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/BackgroundChecks/datalists/vendors": {
"get": {
"tags": [
"BackgroundChecks"
],
"summary": "Get Background Check Vendors",
"description": "Returns a list of Background Checks Vendors ordered by the Name.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): backgroundcheck-read or backgroundcheck-write ````",
"operationId": "BackgroundChecksDatalistsVendorsGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Common.BackgroundCheckVendors.Result, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Common.BackgroundCheckVendors.Result, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Common.BackgroundCheckVendors.Result, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Common.BackgroundCheckVendors.Result, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Common.BackgroundCheckVendors.Result, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Common.BackgroundCheckVendors.Result, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Common.BackgroundCheckVendors.Result, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/BackgroundChecks/datalists/vendors/{backgroundCheckVendorId}": {
"get": {
"tags": [
"BackgroundChecks"
],
"summary": "Get Background Check Vendor",
"description": "Returns a Background Check Vendor.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): backgroundcheck-read or backgroundcheck-write ````",
"operationId": "BackgroundChecksDatalistsVendorsByBackgroundCheckVendorIdGet",
"parameters": [
{
"name": "backgroundCheckVendorId",
"in": "path",
"description": "The background check vendor Id.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Common.BackgroundCheckVendors.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Common.BackgroundCheckVendors.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Common.BackgroundCheckVendors.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Common.BackgroundCheckVendors.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Common.BackgroundCheckVendors.Result"
}
}
}
}
}
}
},
"/BackgroundChecks/order": {
"post": {
"tags": [
"BackgroundChecks"
],
"summary": "Order Background Checks",
"description": "Returns the Ids of the Background Checks. Clients will need to query the status of the background checks for further processing.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): backgroundcheck-write ````",
"operationId": "BackgroundChecksOrderPost",
"requestBody": {
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.BackgroundCheckRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.BackgroundCheckRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.BackgroundCheckRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.BackgroundCheckRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.BackgroundCheckRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.BackgroundCheckRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.BackgroundCheckRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.BackgroundCheckRequest"
}
}
}
},
"responses": {
"202": {
"description": "Orders have been Queued. The list of background checks created will be returned. Check status via /{backgroundCheckId}/status",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Commands.CreateBackgroundCheckOrders.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Commands.CreateBackgroundCheckOrders.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Commands.CreateBackgroundCheckOrders.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Commands.CreateBackgroundCheckOrders.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Commands.CreateBackgroundCheckOrders.Result"
}
}
}
},
"400": {
"description": "Invalid Request"
}
}
}
},
"/BackgroundChecks/order/validate": {
"post": {
"tags": [
"BackgroundChecks"
],
"summary": "Validate Background Check Order Request",
"description": "Returns validation messages regarding the Background Check Order Request. \r\nThis includes both warnings and errors regarding the employee details to be used in the background check request.\r\nUse this endpoint to test the submission prior to sending.\r\nA HttpStatus code 400 will be returned if there is an invalid entry in the request.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): backgroundcheck-write ````",
"operationId": "BackgroundChecksOrderValidatePost",
"requestBody": {
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.BackgroundCheckRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.BackgroundCheckRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.BackgroundCheckRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.BackgroundCheckRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.BackgroundCheckRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.BackgroundCheckRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.BackgroundCheckRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.BackgroundCheckRequest"
}
}
}
},
"responses": {
"200": {
"description": "List of background check validation warnings and errors.",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.BackgroundChecks.BackgroundCheckValidationResult"
}
}
},
"text/csv": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.BackgroundChecks.BackgroundCheckValidationResult"
}
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.BackgroundChecks.BackgroundCheckValidationResult"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.BackgroundChecks.BackgroundCheckValidationResult"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.BackgroundChecks.BackgroundCheckValidationResult"
}
}
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.BackgroundChecks.BackgroundCheckValidationResult"
}
}
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.BackgroundChecks.BackgroundCheckValidationResult"
}
}
}
}
},
"400": {
"description": "Invalid Request."
},
"403": {
"description": "Background Check Feature not available or permission was denied."
},
"404": {
"description": "An item referenced is not found."
}
}
}
},
"/BackgroundChecks/webhooks/vendors/{id}/status": {
"post": {
"tags": [
"BackgroundChecks"
],
"summary": "Post a status update for a background check order.",
"description": "Endpoint will take any object to be parsed at a later time. \r\nThe response will change based upon the Id of the Background Check Vendor.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): backgroundcheck-webhook ````",
"operationId": "BackgroundChecksWebhooksVendorsByIdStatusPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Background Check Vendor Id.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "data",
"in": "query",
"description": "The vendor specific object containing the information about the background check. Serialized and passed in the body of the request.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "queryString",
"in": "query",
"description": "Optionally specify the status update via the query string. Will only be parsed if the body of the request is not supplied.",
"style": "form",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "The status update have been posted and the response contains a vendor specific message.",
"content": {
"text/plain": {
"schema": { },
"example": [{"value":"SampleNote","path":"/PayrollNote","op":"replace"},{"value":50.0,"path":"/OneTimeOverrideRegionWithholding","op":"add"},{"path":"/OneTimeOverrideRegionWithholding","op":"remove"},{"path":"/PayrollNote","op":"copy","from":"/DateWorked"},{"path":"/PayrollNote","op":"move","from":"/DateWorked"},{"value":"SampleNote","path":"/PayrollNote","op":"test"}]
},
"application/json": {
"schema": { },
"example": [{"value":"SampleNote","path":"/PayrollNote","op":"replace"},{"value":50.0,"path":"/OneTimeOverrideRegionWithholding","op":"add"},{"path":"/OneTimeOverrideRegionWithholding","op":"remove"},{"path":"/PayrollNote","op":"copy","from":"/DateWorked"},{"path":"/PayrollNote","op":"move","from":"/DateWorked"},{"value":"SampleNote","path":"/PayrollNote","op":"test"}]
},
"text/json": {
"schema": { },
"example": [{"value":"SampleNote","path":"/PayrollNote","op":"replace"},{"value":50.0,"path":"/OneTimeOverrideRegionWithholding","op":"add"},{"path":"/OneTimeOverrideRegionWithholding","op":"remove"},{"path":"/PayrollNote","op":"copy","from":"/DateWorked"},{"path":"/PayrollNote","op":"move","from":"/DateWorked"},{"value":"SampleNote","path":"/PayrollNote","op":"test"}]
},
"application/xml": {
"schema": { },
"example": "\r\n \r\n \r\n replace\r\n /PayrollNote\r\n SampleNote\r\n \r\n \r\n \r\n add\r\n /OneTimeOverrideRegionWithholding\r\n 50\r\n \r\n \r\n \r\n remove\r\n /OneTimeOverrideRegionWithholding\r\n \r\n \r\n \r\n /DateWorked\r\n copy\r\n /PayrollNote\r\n \r\n \r\n \r\n /DateWorked\r\n move\r\n /PayrollNote\r\n \r\n \r\n \r\n \r\n test\r\n /PayrollNote\r\n SampleNote\r\n \r\n"
},
"text/xml": {
"schema": { },
"example": "\r\n \r\n \r\n replace\r\n /PayrollNote\r\n SampleNote\r\n \r\n \r\n \r\n add\r\n /OneTimeOverrideRegionWithholding\r\n 50\r\n \r\n \r\n \r\n remove\r\n /OneTimeOverrideRegionWithholding\r\n \r\n \r\n \r\n /DateWorked\r\n copy\r\n /PayrollNote\r\n \r\n \r\n \r\n /DateWorked\r\n move\r\n /PayrollNote\r\n \r\n \r\n \r\n \r\n test\r\n /PayrollNote\r\n SampleNote\r\n \r\n"
}
}
},
"204": {
"description": "The status update has been posted."
},
"400": {
"description": "Invalid Request."
},
"403": {
"description": "Background Check Feature not available or permission was denied."
}
}
}
},
"/Branches": {
"get": {
"tags": [
"Branches"
],
"summary": "Get Branches",
"description": "Returns a list of Branches ordered by Branch Name.\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "BranchesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of branches to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of branches to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "restrictToActiveBranches",
"in": "query",
"description": "Optional parameter to limit list to only active or both active and inactive branches. If not specified, this will default to false and all branches will be returned.",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "restrictToWebPublicBranches",
"in": "query",
"description": "Optional parameter to limit list to only web public or both public and private branches. If not specified, this will default to false and all branches will be returned.",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "employerId",
"in": "query",
"description": "Optional parameter to limit the list to only branches belonging to the specified employer. A list of employers can be found in the Employers Datalist.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "postalCode",
"in": "query",
"description": "Optional parameter to see distance to the branches from this postal code in your results. Note\r\n you may either specify the postal code parameter or both latitude and longitude parameters to see distance to the branches.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "latitude",
"in": "query",
"description": "Optional parameter to see distance to the branches from this latitude code in your results. When specified,\r\n you must also specify longitude.",
"style": "form",
"schema": {
"maximum": 90,
"minimum": -90,
"type": "number",
"format": "double"
}
},
{
"name": "longitude",
"in": "query",
"description": "Optional parameter to see distance to the branches from this longitude code in your results. When specified,\r\n you must also specify latitude.",
"style": "form",
"schema": {
"maximum": 180,
"minimum": -180,
"type": "number",
"format": "double"
}
},
{
"name": "distanceUnitId",
"in": "query",
"description": "The unit of the distance provided and returned. Valid values can be found at the Distance Units datalist. Only required when\r\n either postalCode or both latitude and longitude parameters are specified.",
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Branches.BranchList.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Branches.BranchList.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Branches.BranchList.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Branches.BranchList.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Branches.BranchList.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Branches.BranchList.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Branches.BranchList.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Branches/{id}": {
"get": {
"tags": [
"Branches"
],
"summary": "Get Branch",
"description": "Returns information about the specified Branch.\n \n```` Allows roles: Service, ServiceRep, WebUserEmployee ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "BranchesByIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the branch.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Branches.BranchList.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Branches.BranchList.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Branches.BranchList.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Branches.BranchList.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Branches.BranchList.Result"
}
}
}
}
}
}
},
"/BusinessIntelligence/Cloud/Datasets": {
"get": {
"tags": [
"BusinessIntelligence"
],
"summary": "Get Tenant Workspace Dataset List",
"description": "Returns a list of business intelligence datasets based on the users tenant.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "BusinessIntelligenceCloudDatasetsGet",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.ExternalIntegrations.PowerBiCloud.Service.Commands.GetPowerBiWorkspaceDatasets.Result, PowerBiCloud.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.ExternalIntegrations.PowerBiCloud.Service.Commands.GetPowerBiWorkspaceDatasets.Result, PowerBiCloud.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.ExternalIntegrations.PowerBiCloud.Service.Commands.GetPowerBiWorkspaceDatasets.Result, PowerBiCloud.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.ExternalIntegrations.PowerBiCloud.Service.Commands.GetPowerBiWorkspaceDatasets.Result, PowerBiCloud.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.ExternalIntegrations.PowerBiCloud.Service.Commands.GetPowerBiWorkspaceDatasets.Result, PowerBiCloud.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.ExternalIntegrations.PowerBiCloud.Service.Commands.GetPowerBiWorkspaceDatasets.Result, PowerBiCloud.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.ExternalIntegrations.PowerBiCloud.Service.Commands.GetPowerBiWorkspaceDatasets.Result, PowerBiCloud.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/BusinessIntelligence/Cloud/Datasets/{id}": {
"get": {
"tags": [
"BusinessIntelligence"
],
"summary": "Get Workspace Dataset",
"description": "Gets a workspace dataset using the Dataset Id.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "BusinessIntelligenceCloudDatasetsByIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Workspace Dataset Id",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.BusinessIntelligence.Cloud.CloudWorkspaceDataset.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.BusinessIntelligence.Cloud.CloudWorkspaceDataset.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.BusinessIntelligence.Cloud.CloudWorkspaceDataset.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.BusinessIntelligence.Cloud.CloudWorkspaceDataset.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.BusinessIntelligence.Cloud.CloudWorkspaceDataset.Result"
}
}
}
}
}
}
},
"/BusinessIntelligence/Cloud/GenerateToken": {
"post": {
"tags": [
"BusinessIntelligence"
],
"summary": "Get Report Creation Token",
"description": "Generates a token for report creation.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "BusinessIntelligenceCloudGenerateTokenPost",
"requestBody": {
"description": "The request body",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.GeneratePowerBiReportEmbeddedTokenRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.GeneratePowerBiReportEmbeddedTokenRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.GeneratePowerBiReportEmbeddedTokenRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.GeneratePowerBiReportEmbeddedTokenRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.GeneratePowerBiReportEmbeddedTokenRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.GeneratePowerBiReportEmbeddedTokenRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.GeneratePowerBiReportEmbeddedTokenRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.GeneratePowerBiReportEmbeddedTokenRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.BusinessIntelligence.Cloud.CloudWorkspaceGenerateEmbeddedToken.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.BusinessIntelligence.Cloud.CloudWorkspaceGenerateEmbeddedToken.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.BusinessIntelligence.Cloud.CloudWorkspaceGenerateEmbeddedToken.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.BusinessIntelligence.Cloud.CloudWorkspaceGenerateEmbeddedToken.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.BusinessIntelligence.Cloud.CloudWorkspaceGenerateEmbeddedToken.Result"
}
}
}
}
}
}
},
"/BusinessIntelligence/Cloud/Reports": {
"post": {
"tags": [
"BusinessIntelligence"
],
"summary": "Create Power BI Report",
"description": "Creates a Power BI Report.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "BusinessIntelligenceCloudReportsPost",
"requestBody": {
"description": "The request body",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.CreatePowerBiReportRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.CreatePowerBiReportRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.CreatePowerBiReportRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.CreatePowerBiReportRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.CreatePowerBiReportRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.CreatePowerBiReportRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.CreatePowerBiReportRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.CreatePowerBiReportRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.BusinessIntelligence.Cloud.CloudWorkspaceCloneReport.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.BusinessIntelligence.Cloud.CloudWorkspaceCloneReport.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.BusinessIntelligence.Cloud.CloudWorkspaceCloneReport.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.BusinessIntelligence.Cloud.CloudWorkspaceCloneReport.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.BusinessIntelligence.Cloud.CloudWorkspaceCloneReport.Result"
}
}
}
}
}
}
},
"/BusinessIntelligence/Cloud/Reports/{id}": {
"get": {
"tags": [
"BusinessIntelligence"
],
"summary": "Get Workspace Report",
"description": "Gets a workspace report using the Report Id.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "BusinessIntelligenceCloudReportsByIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Workspace Report Id",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.BusinessIntelligence.Cloud.CloudWorkspaceReport.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.BusinessIntelligence.Cloud.CloudWorkspaceReport.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.BusinessIntelligence.Cloud.CloudWorkspaceReport.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.BusinessIntelligence.Cloud.CloudWorkspaceReport.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.BusinessIntelligence.Cloud.CloudWorkspaceReport.Result"
}
}
}
}
}
},
"delete": {
"tags": [
"BusinessIntelligence"
],
"summary": "Delete Workspace Report",
"description": "Deletes a workspace report using the Report Id.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "BusinessIntelligenceCloudReportsByIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Workspace Report Id",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/BusinessIntelligence/Cloud/Reports/{id}/clone": {
"post": {
"tags": [
"BusinessIntelligence"
],
"summary": "Clone Workspace Report",
"description": "Clones an existing workspace report using the Report Id.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "BusinessIntelligenceCloudReportsByIdClonePost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Workspace Report Id",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The request body",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.ClonePowerBiReportRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.ClonePowerBiReportRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.ClonePowerBiReportRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.ClonePowerBiReportRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.ClonePowerBiReportRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.ClonePowerBiReportRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.ClonePowerBiReportRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.ClonePowerBiReportRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.BusinessIntelligence.Cloud.CloudWorkspaceCloneReport.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.BusinessIntelligence.Cloud.CloudWorkspaceCloneReport.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.BusinessIntelligence.Cloud.CloudWorkspaceCloneReport.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.BusinessIntelligence.Cloud.CloudWorkspaceCloneReport.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.BusinessIntelligence.Cloud.CloudWorkspaceCloneReport.Result"
}
}
}
}
}
}
},
"/BusinessIntelligence/Cloud/TenantReports": {
"get": {
"tags": [
"BusinessIntelligence"
],
"summary": "Get Tenant Workspace Report List",
"description": "Returns a list of business intelligence reports based on the users tenant.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "BusinessIntelligenceCloudTenantReportsGet",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.ExternalIntegrations.PowerBiCloud.Service.Commands.GetPowerBiWorkspaceReports.Result, PowerBiCloud.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.ExternalIntegrations.PowerBiCloud.Service.Commands.GetPowerBiWorkspaceReports.Result, PowerBiCloud.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.ExternalIntegrations.PowerBiCloud.Service.Commands.GetPowerBiWorkspaceReports.Result, PowerBiCloud.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.ExternalIntegrations.PowerBiCloud.Service.Commands.GetPowerBiWorkspaceReports.Result, PowerBiCloud.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.ExternalIntegrations.PowerBiCloud.Service.Commands.GetPowerBiWorkspaceReports.Result, PowerBiCloud.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.ExternalIntegrations.PowerBiCloud.Service.Commands.GetPowerBiWorkspaceReports.Result, PowerBiCloud.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.ExternalIntegrations.PowerBiCloud.Service.Commands.GetPowerBiWorkspaceReports.Result, PowerBiCloud.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/BusinessIntelligence/Cloud/Workspaces": {
"get": {
"tags": [
"BusinessIntelligence"
],
"summary": "Get Workspace List",
"description": "Returns a list of business intelligence workspaces.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "BusinessIntelligenceCloudWorkspacesGet",
"parameters": [
{
"name": "filter",
"in": "query",
"description": "Filters the results, based on a boolean condition.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.ExternalIntegrations.PowerBiCloud.Service.Commands.GetPowerBiWorkspaces.Result, PowerBiCloud.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.ExternalIntegrations.PowerBiCloud.Service.Commands.GetPowerBiWorkspaces.Result, PowerBiCloud.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.ExternalIntegrations.PowerBiCloud.Service.Commands.GetPowerBiWorkspaces.Result, PowerBiCloud.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.ExternalIntegrations.PowerBiCloud.Service.Commands.GetPowerBiWorkspaces.Result, PowerBiCloud.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.ExternalIntegrations.PowerBiCloud.Service.Commands.GetPowerBiWorkspaces.Result, PowerBiCloud.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.ExternalIntegrations.PowerBiCloud.Service.Commands.GetPowerBiWorkspaces.Result, PowerBiCloud.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.ExternalIntegrations.PowerBiCloud.Service.Commands.GetPowerBiWorkspaces.Result, PowerBiCloud.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/contactMessages": {
"post": {
"tags": [
"ContactMessages"
],
"summary": "Creates a message and links it to the specified records.",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): message-write ````",
"operationId": "ContactMessagesPost",
"requestBody": {
"description": "The body of the request containing the information required to create the message.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
}
}
}
}
}
},
"/Contacts": {
"post": {
"tags": [
"Contact"
],
"summary": "Create Contact",
"description": "Creates a contact with the specified values.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): contact-write ````",
"operationId": "ContactsPost",
"requestBody": {
"description": "A model containing the information with which to create the new contact.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.CreateContactRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.CreateContactRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.CreateContactRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.CreateContactRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.CreateContactRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.CreateContactRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.CreateContactRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.CreateContactRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Contacts.CreateContact.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Contacts.CreateContact.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Contacts.CreateContact.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Contacts.CreateContact.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Contacts.CreateContact.Result"
}
}
}
}
}
}
},
"/Contacts/{contactId}/messages/{messageId}": {
"put": {
"tags": [
"Contact"
],
"summary": "Update Message",
"description": "Updates a message and links it to the contact.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): contact-read or contact-write ````",
"operationId": "ContactsByContactIdMessagesByMessageIdPut",
"parameters": [
{
"name": "contactId",
"in": "path",
"description": "The Id of the contact",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "messageId",
"in": "path",
"description": "The Id of the message",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The body of the request containing the information required to update the message.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.UpdateMessageWithLinkedDocumentsRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.UpdateMessageWithLinkedDocumentsRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.UpdateMessageWithLinkedDocumentsRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.UpdateMessageWithLinkedDocumentsRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.UpdateMessageWithLinkedDocumentsRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.UpdateMessageWithLinkedDocumentsRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.UpdateMessageWithLinkedDocumentsRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.UpdateMessageWithLinkedDocumentsRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.UpdateContactMessageResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.UpdateContactMessageResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.UpdateContactMessageResult"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.UpdateContactMessageResult"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.UpdateContactMessageResult"
}
}
}
}
}
}
},
"/Contacts/{contactId}/messages/{messageId}/documents": {
"post": {
"tags": [
"Contact"
],
"summary": "Upload document to a message",
"description": "\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): contact-write ````",
"operationId": "ContactsByContactIdMessagesByMessageIdDocumentsPost",
"parameters": [
{
"name": "contactId",
"in": "path",
"description": "The Id of the contact.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "messageId",
"in": "path",
"description": "The Id of the message.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"required": [
"DocumentName",
"DocumentTypeId"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
},
"DocumentName": {
"type": "string"
},
"DocumentTypeId": {
"type": "integer",
"format": "int32"
},
"Description": {
"maxLength": 255,
"type": "string"
},
"ExpirationDate": {
"type": "string",
"format": "date-time"
},
"Version": {
"type": "string"
}
}
},
"encoding": {
"File": {
"style": "form"
},
"DocumentName": {
"style": "form"
},
"DocumentTypeId": {
"style": "form"
},
"Description": {
"style": "form"
},
"ExpirationDate": {
"style": "form"
},
"Version": {
"style": "form"
}
}
}
}
},
"responses": {
"201": {
"description": "Id of the new document.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
}
}
}
}
}
},
"/Contacts/{id}": {
"get": {
"tags": [
"Contact"
],
"summary": "Get Details",
"description": "Gets detailed information about the specified contact.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): contact-read or contact-write ````",
"operationId": "ContactsByIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.Service.Commands.ContactDetailsQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.Service.Commands.ContactDetailsQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.Service.Commands.ContactDetailsQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.Service.Commands.ContactDetailsQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.Service.Commands.ContactDetailsQuery.Result"
}
}
}
}
}
},
"patch": {
"tags": [
"Contact"
],
"summary": "Patch Contact Basic Information",
"description": "\r\n\r\n Allows for Json patching to be performed against basic contact fields.\r\n More information about PATCHING, see https://developer.ontempworks.com/docs/your-request\r\n \r\n\r\n\r\n Valid Patch paths: /FirstName(string), /LastName(string), /Title(string), /Nickname(string), /Honorific(string), /Birthday(string), /CustomerId(long?), /CompanyId(int?), /BranchId(int), /ContactStatusId(string), /EmployeeId(long?), /WorksiteId(int?), /Note(string), /PrimaryPhoneNumberContactMethodId(int?), /PrimaryEmailAddressContactMethodId(int?), /PrimaryMessageId(long?), /HowHeardOfId(int?), /HowHeardOfDetail(string), /ServiceRepId(int)\r\n \n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): contact-write ````",
"operationId": "ContactsByIdPatch",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "A Json array of patch operations to be performed.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":"John","path":"/FirstName","op":"replace"},{"value":"SampleTitle","path":"/Title","op":"add"},{"path":"/Title","op":"remove"},{"path":"/Note","op":"copy","from":"/NickName"},{"path":"/Note","op":"move","from":"/NickName"},{"value":"John","path":"/FirstName","op":"test"}]
},
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":"John","path":"/FirstName","op":"replace"},{"value":"SampleTitle","path":"/Title","op":"add"},{"path":"/Title","op":"remove"},{"path":"/Note","op":"copy","from":"/NickName"},{"path":"/Note","op":"move","from":"/NickName"},{"value":"John","path":"/FirstName","op":"test"}]
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":"John","path":"/FirstName","op":"replace"},{"value":"SampleTitle","path":"/Title","op":"add"},{"path":"/Title","op":"remove"},{"path":"/Note","op":"copy","from":"/NickName"},{"path":"/Note","op":"move","from":"/NickName"},{"value":"John","path":"/FirstName","op":"test"}]
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":"John","path":"/FirstName","op":"replace"},{"value":"SampleTitle","path":"/Title","op":"add"},{"path":"/Title","op":"remove"},{"path":"/Note","op":"copy","from":"/NickName"},{"path":"/Note","op":"move","from":"/NickName"},{"value":"John","path":"/FirstName","op":"test"}]
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":"John","path":"/FirstName","op":"replace"},{"value":"SampleTitle","path":"/Title","op":"add"},{"path":"/Title","op":"remove"},{"path":"/Note","op":"copy","from":"/NickName"},{"path":"/Note","op":"move","from":"/NickName"},{"value":"John","path":"/FirstName","op":"test"}]
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": "\r\n \r\n \r\n replace\r\n /FirstName\r\n John\r\n \r\n \r\n \r\n add\r\n /Title\r\n SampleTitle\r\n \r\n \r\n \r\n remove\r\n /Title\r\n \r\n \r\n \r\n /NickName\r\n copy\r\n /Note\r\n \r\n \r\n \r\n /NickName\r\n move\r\n /Note\r\n \r\n \r\n \r\n \r\n test\r\n /FirstName\r\n John\r\n \r\n"
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": "\r\n \r\n \r\n replace\r\n /FirstName\r\n John\r\n \r\n \r\n \r\n add\r\n /Title\r\n SampleTitle\r\n \r\n \r\n \r\n remove\r\n /Title\r\n \r\n \r\n \r\n /NickName\r\n copy\r\n /Note\r\n \r\n \r\n \r\n /NickName\r\n move\r\n /Note\r\n \r\n \r\n \r\n \r\n test\r\n /FirstName\r\n John\r\n \r\n"
},
"application/*+xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": "\r\n \r\n \r\n replace\r\n /FirstName\r\n John\r\n \r\n \r\n \r\n add\r\n /Title\r\n SampleTitle\r\n \r\n \r\n \r\n remove\r\n /Title\r\n \r\n \r\n \r\n /NickName\r\n copy\r\n /Note\r\n \r\n \r\n \r\n /NickName\r\n move\r\n /Note\r\n \r\n \r\n \r\n \r\n test\r\n /FirstName\r\n John\r\n \r\n"
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Contacts/{id}/address": {
"put": {
"tags": [
"Contact"
],
"summary": "Update Address",
"description": "Updates the specified contact's address. If the address is in the United States, the system will validate it\r\nusing the configured address validation service. This validation can be bypassed by setting\r\nBypassAddressValidationService to true.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): contact-write ````",
"operationId": "ContactsByIdAddressPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The request body containing the updated address values.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.UpdateContactAddressRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.UpdateContactAddressRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.UpdateContactAddressRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.UpdateContactAddressRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.UpdateContactAddressRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.UpdateContactAddressRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.UpdateContactAddressRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.UpdateContactAddressRequest"
}
}
}
},
"responses": {
"204": {
"description": "The request succeeded."
},
"520": {
"description": "The address validation service is encountering server issues. Try again later."
},
"521": {
"description": "The address validation service is encountering issues with the request."
}
}
}
},
"/Contacts/{id}/contactmethods": {
"post": {
"tags": [
"Contact"
],
"summary": "Create Contact Method",
"description": "Creates a contact method for the specified contact.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): contact-write ````",
"operationId": "ContactsByIdContactmethodsPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The contact method to create",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMethods.CreateEntityContactMethodRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMethods.CreateEntityContactMethodRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMethods.CreateEntityContactMethodRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMethods.CreateEntityContactMethodRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMethods.CreateEntityContactMethodRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMethods.CreateEntityContactMethodRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMethods.CreateEntityContactMethodRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMethods.CreateEntityContactMethodRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.ContactMethods.CreateEntityContactMethodCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.ContactMethods.CreateEntityContactMethodCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.ContactMethods.CreateEntityContactMethodCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.ContactMethods.CreateEntityContactMethodCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.ContactMethods.CreateEntityContactMethodCommand.Result"
}
}
}
}
}
}
},
"/Contacts/{id}/contactMethods": {
"get": {
"tags": [
"Contact"
],
"summary": "Get Contact Methods",
"description": "Gets a list of contact methods for the specified contact. The contact methods are ordered alphabetically by their type.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): contact-read or contact-write ````",
"operationId": "ContactsByIdContactMethodsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of contact methods to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of contact methods to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.ContactMethods.EntityContactMethod, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.ContactMethods.EntityContactMethod, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.ContactMethods.EntityContactMethod, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.ContactMethods.EntityContactMethod, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.ContactMethods.EntityContactMethod, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.ContactMethods.EntityContactMethod, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.ContactMethods.EntityContactMethod, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Contacts/{id}/contactmethods/{contactMethodId}": {
"delete": {
"tags": [
"Contact"
],
"summary": "Delete Contact Method",
"description": "Deletes a contact method from the specified contact.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): contact-write ````",
"operationId": "ContactsByIdContactmethodsByContactMethodIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "contactMethodId",
"in": "path",
"description": "The Id of the contact method",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
},
"patch": {
"tags": [
"Contact"
],
"summary": "Patch Contact Method",
"description": "\r\n\r\n Performs the specified patching operations against a contact method from the specified contact.\r\n More information about PATCHING, see https://developer.ontempworks.com/docs/your-request\r\n \r\n\r\n\r\n Valid Patch paths: /ContactMethodTypeId(short), /ContactMethod(string), /IsActive(bool), /Notes(string), /WhenAvailable(string), /AreaCode(int), /ProviderId(int), /CountryCallingCode(int?), /IsPinned(bool)\r\n \n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): contact-write ````",
"operationId": "ContactsByIdContactmethodsByContactMethodIdPatch",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "contactMethodId",
"in": "path",
"description": "The Id of the contact method",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The list of patch operations to perform on the contact method",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":"6514520366","path":"/ContactMethod","op":"replace"},{"value":1,"path":"/CountryCallingCode","op":"add"},{"path":"/CountryCallingCode","op":"remove"},{"path":"/Notes","op":"copy","from":"/CountryCallingCode"},{"path":"/Notes","op":"move","from":"/CountryCallingCode"},{"value":"6514520366","path":"/ContactMethod","op":"test"}]
},
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":"6514520366","path":"/ContactMethod","op":"replace"},{"value":1,"path":"/CountryCallingCode","op":"add"},{"path":"/CountryCallingCode","op":"remove"},{"path":"/Notes","op":"copy","from":"/CountryCallingCode"},{"path":"/Notes","op":"move","from":"/CountryCallingCode"},{"value":"6514520366","path":"/ContactMethod","op":"test"}]
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":"6514520366","path":"/ContactMethod","op":"replace"},{"value":1,"path":"/CountryCallingCode","op":"add"},{"path":"/CountryCallingCode","op":"remove"},{"path":"/Notes","op":"copy","from":"/CountryCallingCode"},{"path":"/Notes","op":"move","from":"/CountryCallingCode"},{"value":"6514520366","path":"/ContactMethod","op":"test"}]
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":"6514520366","path":"/ContactMethod","op":"replace"},{"value":1,"path":"/CountryCallingCode","op":"add"},{"path":"/CountryCallingCode","op":"remove"},{"path":"/Notes","op":"copy","from":"/CountryCallingCode"},{"path":"/Notes","op":"move","from":"/CountryCallingCode"},{"value":"6514520366","path":"/ContactMethod","op":"test"}]
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":"6514520366","path":"/ContactMethod","op":"replace"},{"value":1,"path":"/CountryCallingCode","op":"add"},{"path":"/CountryCallingCode","op":"remove"},{"path":"/Notes","op":"copy","from":"/CountryCallingCode"},{"path":"/Notes","op":"move","from":"/CountryCallingCode"},{"value":"6514520366","path":"/ContactMethod","op":"test"}]
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": "\r\n \r\n \r\n replace\r\n /ContactMethod\r\n 6514520366\r\n \r\n \r\n \r\n add\r\n /CountryCallingCode\r\n 1\r\n \r\n \r\n \r\n remove\r\n /CountryCallingCode\r\n \r\n \r\n \r\n /CountryCallingCode\r\n copy\r\n /Notes\r\n \r\n \r\n \r\n /CountryCallingCode\r\n move\r\n /Notes\r\n \r\n \r\n \r\n \r\n test\r\n /ContactMethod\r\n 6514520366\r\n \r\n"
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": "\r\n \r\n \r\n replace\r\n /ContactMethod\r\n 6514520366\r\n \r\n \r\n \r\n add\r\n /CountryCallingCode\r\n 1\r\n \r\n \r\n \r\n remove\r\n /CountryCallingCode\r\n \r\n \r\n \r\n /CountryCallingCode\r\n copy\r\n /Notes\r\n \r\n \r\n \r\n /CountryCallingCode\r\n move\r\n /Notes\r\n \r\n \r\n \r\n \r\n test\r\n /ContactMethod\r\n 6514520366\r\n \r\n"
},
"application/*+xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": "\r\n \r\n \r\n replace\r\n /ContactMethod\r\n 6514520366\r\n \r\n \r\n \r\n add\r\n /CountryCallingCode\r\n 1\r\n \r\n \r\n \r\n remove\r\n /CountryCallingCode\r\n \r\n \r\n \r\n /CountryCallingCode\r\n copy\r\n /Notes\r\n \r\n \r\n \r\n /CountryCallingCode\r\n move\r\n /Notes\r\n \r\n \r\n \r\n \r\n test\r\n /ContactMethod\r\n 6514520366\r\n \r\n"
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Contacts/{id}/contactMethods/{contactMethodId}": {
"get": {
"tags": [
"Contact"
],
"summary": "Get Contact Method",
"description": "Gets a contact method for the specified contact.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): contact-read or contact-write ````",
"operationId": "ContactsByIdContactMethodsByContactMethodIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "contactMethodId",
"in": "path",
"description": "The Id of the contact method",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMethods.EntityContactMethod"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMethods.EntityContactMethod"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMethods.EntityContactMethod"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMethods.EntityContactMethod"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMethods.EntityContactMethod"
}
}
}
}
}
}
},
"/Contacts/{id}/contactmethods/{contactMethodId}/text": {
"post": {
"tags": [
"Contact"
],
"summary": "Initiate a one to one text message conversation.",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): textmessage-read ````",
"operationId": "ContactsByIdContactmethodsByContactMethodIdTextPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "contactMethodId",
"in": "path",
"description": "The Id of the contact method",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "A request containing the externalServiceId",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMethods.SendTextMessageToContactMethodRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMethods.SendTextMessageToContactMethodRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMethods.SendTextMessageToContactMethodRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMethods.SendTextMessageToContactMethodRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMethods.SendTextMessageToContactMethodRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMethods.SendTextMessageToContactMethodRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMethods.SendTextMessageToContactMethodRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMethods.SendTextMessageToContactMethodRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Texting.SendTextMessageToContactMethod.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Texting.SendTextMessageToContactMethod.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Texting.SendTextMessageToContactMethod.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Texting.SendTextMessageToContactMethod.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Texting.SendTextMessageToContactMethod.Result"
}
}
}
}
}
}
},
"/Contacts/{id}/contactMethods/summary": {
"get": {
"tags": [
"Contact"
],
"summary": "Get Contact Method Summary",
"description": "Gets the primary contact methods for the contact as well as all of the pinned contact methods and the total number of contact methods.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): contact-read or contact-write ````",
"operationId": "ContactsByIdContactMethodsSummaryGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.ContactMethods.EntityContactMethod, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.ContactMethods.EntityContactMethod, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.ContactMethods.EntityContactMethod, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.ContactMethods.EntityContactMethod, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.ContactMethods.EntityContactMethod, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.ContactMethods.EntityContactMethod, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.ContactMethods.EntityContactMethod, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Contacts/{id}/CustomData": {
"get": {
"tags": [
"Contact"
],
"summary": "Get Custom Data",
"description": "Gets a list of Custom Data Properties for a Contact.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): contact-read or contact-write ````",
"operationId": "ContactsByIdCustomDataGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "includeInactiveProperties",
"in": "query",
"description": "When true, any properties that have been marked inactive will also be returned.",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.CustomData.EntityCustomDataQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.CustomData.EntityCustomDataQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.CustomData.EntityCustomDataQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.CustomData.EntityCustomDataQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.CustomData.EntityCustomDataQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.CustomData.EntityCustomDataQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.CustomData.EntityCustomDataQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"put": {
"tags": [
"Contact"
],
"summary": "Update Custom Data",
"description": "Updates the Custom Data Properties for a Contact.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): contact-write ````",
"operationId": "ContactsByIdCustomDataPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The list of values to store.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.CustomData.UpdateEntityCustomDataRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.CustomData.UpdateEntityCustomDataRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.CustomData.UpdateEntityCustomDataRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.CustomData.UpdateEntityCustomDataRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.CustomData.UpdateEntityCustomDataRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.CustomData.UpdateEntityCustomDataRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.CustomData.UpdateEntityCustomDataRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.CustomData.UpdateEntityCustomDataRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Contacts/{id}/documents": {
"get": {
"tags": [
"Contact"
],
"summary": "Get Documents",
"description": "Gets a list of documents linked to the contact.\n \n```` Allows roles: ServiceRep, WebUserContact, Service ````\n \n```` Requires scope(s): contact-read or contact-write ````",
"operationId": "ContactsByIdDocumentsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of documents to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of documents to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "sortByAscending",
"in": "query",
"description": "true to sort by ASC, defaults to DESC",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "sortBy",
"in": "query",
"description": "Field to sort by, valid fields are \"DocumentType\" and \"DocumentDate\"",
"style": "form",
"schema": {
"type": "string",
"default": "DocumentDate"
}
},
{
"name": "filterByDocumentTypeId",
"in": "query",
"description": "DocumentTypeId to filter by",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Documents.GetEntityDocumentsQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Documents.GetEntityDocumentsQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Documents.GetEntityDocumentsQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Documents.GetEntityDocumentsQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Documents.GetEntityDocumentsQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Documents.GetEntityDocumentsQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Documents.GetEntityDocumentsQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Contact"
],
"summary": "Upload Document",
"description": "Uploads a document to the contact. This requires a multipart form-data POST request. \r\nOne part must contain the file to upload and subsequent parts will be used to provide \r\nother data such as documentTypeId.\r\n\r\nFor more information about using formdata, see: https://developer.mozilla.org/en-US/docs/Web/API/FormData/FormData\r\nFor more information about using multipart/form-data, see: http://stackoverflow.com/questions/4526273/what-does-enctype-multipart-form-data-mean\r\nBelow is an example multipart/form-data POST request body:\r\n\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn\r\nContent-Disposition: form-data; name=\"file\"; filename=\"Test.txt\"\r\nContent-Type: text/plain\r\n\r\nThis is where the file content is placed! This is a valid for a text document!\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn\r\nContent-Disposition: form-data; name=\"fileName\"\r\n\r\nNewFileName.txt\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn\r\nContent-Disposition: form-data; name=\"expirationDate\"\r\n\r\n2012-12-21\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn\r\nContent-Disposition: form-data; name=\"documentTypeId\"\r\n\r\n1\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn\r\nContent-Disposition: form-data; name=\"version\"\r\n\r\n1\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn\r\nContent-Disposition: form-data; name=\"description\"\r\n\r\ntest\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn--\n \n```` Allows roles: Service, ServiceRep, WebUserContact ````\n \n```` Requires scope(s): contact-write ````",
"operationId": "ContactsByIdDocumentsPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"201": {
"description": "Id of the new document",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
}
}
}
}
}
},
"/Contacts/{id}/documents/{documentId}": {
"get": {
"tags": [
"Contact"
],
"summary": "Get Document Details",
"description": "Gets detailed information about the specified document for the specified contact.\n \n```` Allows roles: ServiceRep, WebUserContact, WebUserServiceRep, Service ````\n \n```` Requires scope(s): contact-read or contact-write ````",
"operationId": "ContactsByIdDocumentsByDocumentIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "documentId",
"in": "path",
"description": "The Id of the document.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.GetEntityDocumentQuery.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.GetEntityDocumentQuery.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.GetEntityDocumentQuery.Document"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.GetEntityDocumentQuery.Document"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.GetEntityDocumentQuery.Document"
}
}
}
}
}
},
"put": {
"tags": [
"Contact"
],
"summary": "Update Document Details",
"description": "Updates detail information about the document.\n \n```` Allows roles: ServiceRep, WebUserContact, Service ````\n \n```` Requires scope(s): contact-write ````",
"operationId": "ContactsByIdDocumentsByDocumentIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "documentId",
"in": "path",
"description": "The Id of the document.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The body of the request containing the updated details information.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Documents.UpdateEntityDocumentDetailsRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Documents.UpdateEntityDocumentDetailsRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Documents.UpdateEntityDocumentDetailsRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Documents.UpdateEntityDocumentDetailsRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Documents.UpdateEntityDocumentDetailsRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Documents.UpdateEntityDocumentDetailsRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Documents.UpdateEntityDocumentDetailsRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Documents.UpdateEntityDocumentDetailsRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
},
"delete": {
"tags": [
"Contact"
],
"summary": "Delete Document",
"description": "Deletes the specified document.\n \n```` Allows roles: ServiceRep, WebUserContact, Service ````\n \n```` Requires scope(s): contact-write ````",
"operationId": "ContactsByIdDocumentsByDocumentIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "documentId",
"in": "path",
"description": "The Id of the document.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Contacts/{id}/documents/{documentId}/bytes": {
"get": {
"tags": [
"Contact"
],
"summary": "Get Document",
"description": "Gets the specified document for the specified contact.\n \n```` Allows roles: ServiceRep, WebUserContact, Service ````\n \n```` Requires scope(s): contact-read or contact-write ````",
"operationId": "ContactsByIdDocumentsByDocumentIdBytesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "documentId",
"in": "path",
"description": "The Id of the document.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "returnPdf",
"in": "query",
"description": "Used to indicated whether or not a PDF should be returned if the file is convertable to PDF",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "string",
"format": "byte"
}
},
"text/csv": {
"schema": {
"type": "string",
"format": "byte"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"type": "string",
"format": "byte"
}
},
"application/json": {
"schema": {
"type": "string",
"format": "byte"
}
},
"text/json": {
"schema": {
"type": "string",
"format": "byte"
}
},
"application/xml": {
"schema": {
"type": "string",
"format": "byte"
}
},
"text/xml": {
"schema": {
"type": "string",
"format": "byte"
}
}
}
}
}
}
},
"/Contacts/{id}/documents/metadata": {
"get": {
"tags": [
"Contact"
],
"summary": "Get Documents Metadata",
"description": "Returns information about document creation restrictions.\n \n```` Allows roles: ServiceRep, WebUserContact, Service ````\n \n```` Requires scope(s): contact-read or contact-write ````",
"operationId": "ContactsByIdDocumentsMetadataGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.DocumentMetadataQuery.Query"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.DocumentMetadataQuery.Query"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.DocumentMetadataQuery.Query"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.DocumentMetadataQuery.Query"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.DocumentMetadataQuery.Query"
}
}
}
}
}
}
},
"/Contacts/{id}/interestCodes": {
"get": {
"tags": [
"Contact"
],
"summary": "Get Contact Interest Codes",
"description": "Returns a paged list of contact interest codes ordered by the InterestCode column.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): contact-read or contact-write ````",
"operationId": "ContactsByIdInterestCodesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of interest codes to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of interest codes to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Contacts.Service.Commands.InterestCodes.ContactInterestCodesQuery.Result, Contacts.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Contacts.Service.Commands.InterestCodes.ContactInterestCodesQuery.Result, Contacts.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Contacts.Service.Commands.InterestCodes.ContactInterestCodesQuery.Result, Contacts.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Contacts.Service.Commands.InterestCodes.ContactInterestCodesQuery.Result, Contacts.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Contacts.Service.Commands.InterestCodes.ContactInterestCodesQuery.Result, Contacts.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Contacts.Service.Commands.InterestCodes.ContactInterestCodesQuery.Result, Contacts.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Contacts.Service.Commands.InterestCodes.ContactInterestCodesQuery.Result, Contacts.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Contact"
],
"summary": "Create Contact Interest Code",
"description": "Creates a contact interest code.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): contact-write ````",
"operationId": "ContactsByIdInterestCodesPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The request body containing the contact interest code to create.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.CreateContactInterestCodeRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.CreateContactInterestCodeRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.CreateContactInterestCodeRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.CreateContactInterestCodeRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.CreateContactInterestCodeRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.CreateContactInterestCodeRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.CreateContactInterestCodeRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.CreateContactInterestCodeRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.Service.Commands.InterestCodes.CreateContactInterestCodeCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.Service.Commands.InterestCodes.CreateContactInterestCodeCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.Service.Commands.InterestCodes.CreateContactInterestCodeCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.Service.Commands.InterestCodes.CreateContactInterestCodeCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.Service.Commands.InterestCodes.CreateContactInterestCodeCommand.Result"
}
}
}
}
}
},
"put": {
"tags": [
"Contact"
],
"summary": "Update Contact Interest Codes",
"description": "Updates a contact's interest codes.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): contact-write ````",
"operationId": "ContactsByIdInterestCodesPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The request body containing an updated list of the contact's interest codes.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.UpdateContactInterestCodesRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.UpdateContactInterestCodesRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.UpdateContactInterestCodesRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.UpdateContactInterestCodesRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.UpdateContactInterestCodesRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.UpdateContactInterestCodesRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.UpdateContactInterestCodesRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.UpdateContactInterestCodesRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Contacts/{id}/interestCodes/{contactInterestCodeId}": {
"get": {
"tags": [
"Contact"
],
"summary": "Get Contact Interest Code",
"description": "Returns a contact interest code.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): contact-read or contact-write ````",
"operationId": "ContactsByIdInterestCodesByContactInterestCodeIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "contactInterestCodeId",
"in": "path",
"description": "The Id of the contact interest code.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.Service.Commands.InterestCodes.ContactInterestCodesQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.Service.Commands.InterestCodes.ContactInterestCodesQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.Service.Commands.InterestCodes.ContactInterestCodesQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.Service.Commands.InterestCodes.ContactInterestCodesQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.Service.Commands.InterestCodes.ContactInterestCodesQuery.Result"
}
}
}
}
}
},
"delete": {
"tags": [
"Contact"
],
"summary": "Delete Contact Interest Code",
"description": "Deletes a contact interest code.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): contact-write ````",
"operationId": "ContactsByIdInterestCodesByContactInterestCodeIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "contactInterestCodeId",
"in": "path",
"description": "The Id of the contact interest code to delete.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
},
"put": {
"tags": [
"Contact"
],
"summary": "Update Contact Interest Code",
"description": "Updates a contact interest code. Note that updates on the InterestCodeId will set the date created to today.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): contact-write ````",
"operationId": "ContactsByIdInterestCodesByContactInterestCodeIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "contactInterestCodeId",
"in": "path",
"description": "The Id of the contact interest code.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The request body containing the contact interest code to update.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.UpdateContactInterestCodeRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.UpdateContactInterestCodeRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.UpdateContactInterestCodeRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.UpdateContactInterestCodeRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.UpdateContactInterestCodeRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.UpdateContactInterestCodeRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.UpdateContactInterestCodeRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.UpdateContactInterestCodeRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Contacts/{id}/messages": {
"get": {
"tags": [
"Contact"
],
"summary": "Get Messages",
"description": "Gets a list of messages linked to the Contact. The Messages are ordered from newest to the oldest.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): contact-read or contact-write ````",
"operationId": "ContactsByIdMessagesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of messages to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of messages to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "messageActionId",
"in": "query",
"description": "Optional filter on the Id of the message action. Valid values can be found in the Message Action List. ref: /datalists/messageactions",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "messageActionTypeId",
"in": "query",
"description": "Optional filter on the Id of the message action type. Valid values can be found in the Message Action Type List. ref: /datalists/messageactiontypes",
"style": "form",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "authorSrIdent",
"in": "query",
"description": "Optional filter on the Id of the Service Rep who created the message.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "startDate",
"in": "query",
"description": "Optional filter on the date of the message. Any messages created on or after the date supplied will be returned.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "endDate",
"in": "query",
"description": "Optional filter on the date of the message. Any messages created on or before the date supplied will be returned.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "orderBy",
"in": "query",
"description": "Optional parameter to specify the column to order by. Valid values are 'date', 'action', 'actiondescription','authorsrident','author','id', and 'message', Defaults to 'date'",
"style": "form",
"schema": {
"maxLength": 150,
"minLength": 0,
"type": "string"
}
},
{
"name": "orderByAscending",
"in": "query",
"description": "Optional parameter to specify the direction to order by. Specify true to order ascending.",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "messageText",
"in": "query",
"description": "Optional parameter to search on the message text. To search for any message which contains a word which starts with accep, the value would be: accep*",
"style": "form",
"schema": {
"maxLength": 1000,
"minLength": 0,
"type": "string"
}
},
{
"name": "limitToPrimaryMessages",
"in": "query",
"description": "Set to true to only return the primary messages. Currently only one primary message is supported. \r\n This can be set using the endpoint PATCH contacts/{id} and setting the value PrimaryMessageId.\r\n Optional filters such as start date and end date are ignored when this value is true.",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Contact"
],
"summary": "Create Message",
"description": "Creates a message and links it to the contact.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): contact-read or contact-write ````",
"operationId": "ContactsByIdMessagesPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The body of the request containing the information required to create the message.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateMessageWithLinkedDocumentsRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateMessageWithLinkedDocumentsRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateMessageWithLinkedDocumentsRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateMessageWithLinkedDocumentsRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateMessageWithLinkedDocumentsRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateMessageWithLinkedDocumentsRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateMessageWithLinkedDocumentsRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateMessageWithLinkedDocumentsRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
}
}
}
}
}
},
"/Contacts/{id}/messages/{messageId}": {
"get": {
"tags": [
"Contact"
],
"summary": "Gets the details of a specific message.",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): contact-read or contact-write ````",
"operationId": "ContactsByIdMessagesByMessageIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "messageId",
"in": "path",
"description": "The Id of the message.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageDetails"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageDetails"
}
}
}
}
}
}
},
"/Contacts/{id}/messages/relatedEntities": {
"get": {
"tags": [
"Contact"
],
"summary": "Gets the specified contact`s related entities.",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): contact-read or contact-write ````",
"operationId": "ContactsByIdMessagesRelatedEntitiesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the contact.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageLink"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageLink"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageLink"
}
}
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageLink"
}
}
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageLink"
}
}
}
}
}
}
}
},
"/Contacts/{id}/Status": {
"post": {
"tags": [
"Contact"
],
"summary": "Update Contact Status",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): contact-write ````",
"operationId": "ContactsByIdStatusPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The details of the status change.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.StatusChange.StatusChangeApiRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.StatusChange.StatusChangeApiRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.StatusChange.StatusChangeApiRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.StatusChange.StatusChangeApiRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.StatusChange.StatusChangeApiRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.StatusChange.StatusChangeApiRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.StatusChange.StatusChangeApiRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.StatusChange.StatusChangeApiRequest"
}
}
}
},
"responses": {
"200": {
"description": "Status Changed",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.Service.Commands.ContactStatusUpdateCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.Service.Commands.ContactStatusUpdateCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.Service.Commands.ContactStatusUpdateCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.Service.Commands.ContactStatusUpdateCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.Service.Commands.ContactStatusUpdateCommand.Result"
}
}
}
},
"202": {
"description": "Status Changed and Additional Actions are staged for execution or had errors that require additional attention.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.Service.Commands.ContactStatusUpdateCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.Service.Commands.ContactStatusUpdateCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.Service.Commands.ContactStatusUpdateCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.Service.Commands.ContactStatusUpdateCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.Service.Commands.ContactStatusUpdateCommand.Result"
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/Contacts/{id}/Status/{newContactStatusId}/metadata": {
"get": {
"tags": [
"Contact"
],
"summary": "Get Contact Status Change Metadata",
"description": "Returns the metadata regarding the status change for a Contact. \r\n This includes information regarding the additional actions, validation, and the current state of the prerequisites for the status change.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): contact-read or contact-write ````",
"operationId": "ContactsByIdStatusByNewContactStatusIdMetadataGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "newContactStatusId",
"in": "path",
"description": "The Id of the new contact status.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
},
{
"name": "returnAllPrerequisites",
"in": "query",
"description": "When true, all dynamic validation results are returned regardless of error or not. \r\n When false, only the prerequisites that have had errors are returned. Defaults to false.",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "returnAllAdditionalActions",
"in": "query",
"description": "When true, both required and optional additional actions are returned. \r\n When false, only additional actions that are optional are returned. Defaults to true.",
"style": "form",
"schema": {
"type": "boolean",
"default": true
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.StatusChange.OriginStatusChangeMetadataQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.StatusChange.OriginStatusChangeMetadataQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.StatusChange.OriginStatusChangeMetadataQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.StatusChange.OriginStatusChangeMetadataQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.StatusChange.OriginStatusChangeMetadataQuery.Result"
}
}
}
}
}
}
},
"/Contacts/{id}/summary": {
"get": {
"tags": [
"Contact"
],
"summary": "Get Summary",
"description": "Gets summary information about the specified contact.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): contact-read or contact-write ````",
"operationId": "ContactsByIdSummaryGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Contacts.ContactSummary.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Contacts.ContactSummary.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Contacts.ContactSummary.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Contacts.ContactSummary.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Contacts.ContactSummary.Result"
}
}
}
}
}
}
},
"/Contacts/{id}/tasks": {
"get": {
"tags": [
"Contact"
],
"summary": "Get Contact Tasks",
"description": "Returns the list of tasks linked to the contact and belonging to the current user.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): (contact-read or contact-write) and (task-read or task-write) ````",
"operationId": "ContactsByIdTasksGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "TaskQueryType",
"in": "query",
"required": true,
"style": "form",
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Enums.TaskQueryTypes"
}
},
{
"name": "Skip",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Take",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "StartDueDate",
"in": "query",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "EndDueDate",
"in": "query",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "Priority",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "IncludeNullDueDates",
"in": "query",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "FilterText",
"in": "query",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "AssignedToServiceRepId",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "TeamId",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "CreatedByServiceRepId",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "IsPinned",
"in": "query",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "StartDateArchived",
"in": "query",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "EndDateArchived",
"in": "query",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "OrderBy",
"in": "query",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "OrderByAscending",
"in": "query",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "Tags",
"in": "query",
"style": "form",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Tasks.TaskListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Tasks.TaskListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Tasks.TaskListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Tasks.TaskListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Tasks.TaskListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Tasks.TaskListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Tasks.TaskListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Contact"
],
"summary": "Create Contact Task",
"description": "Creates a task and links it to the contact.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): contact-write and task-write ````",
"operationId": "ContactsByIdTasksPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The body of the request containing the information required to create the task.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateEntityTaskRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateEntityTaskRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateEntityTaskRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateEntityTaskRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateEntityTaskRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateEntityTaskRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateEntityTaskRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateEntityTaskRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.CreateTaskCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.CreateTaskCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.CreateTaskCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.CreateTaskCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.CreateTaskCommand.Result"
}
}
}
}
}
}
},
"/Contacts/{id}/tasks/{taskId}": {
"get": {
"tags": [
"Contact"
],
"summary": "Get Contact Task Details",
"description": "Gets more detailed information about a task pertaining to the contact.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): (contact-read or contact-write) and (task-read or task-write) ````",
"operationId": "ContactsByIdTasksByTaskIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.TaskDetailsQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.TaskDetailsQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.TaskDetailsQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.TaskDetailsQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.TaskDetailsQuery.Result"
}
}
}
}
}
},
"put": {
"tags": [
"Contact"
],
"summary": "Update Contact Task",
"description": "Updates a task linked to the contact.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): contact-write and task-write ````",
"operationId": "ContactsByIdTasksByTaskIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The body of the request containing the updated task details.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.UpdateTaskRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.UpdateTaskRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.UpdateTaskRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.UpdateTaskRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.UpdateTaskRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.UpdateTaskRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.UpdateTaskRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.UpdateTaskRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Contacts/{id}/tasks/{taskId}/archive": {
"put": {
"tags": [
"Contact"
],
"summary": "Archive Contact Task",
"description": "Archives the task linked to the contact.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): contact-write and task-write ````",
"operationId": "ContactsByIdTasksByTaskIdArchivePut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Contacts/{id}/tasks/{taskId}/assign": {
"put": {
"tags": [
"Contact"
],
"summary": "Assign Contact Task",
"description": "Assigns the task linked to the contact.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): task-write ````",
"operationId": "ContactsByIdTasksByTaskIdAssignPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The body of the request containing the new assignment details for the task.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Contacts/{id}/tasks/{taskId}/messages": {
"get": {
"tags": [
"Contact"
],
"summary": "Get Contact Task Messages List",
"description": "Returns the list of messages linked to the task.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): task-read or task-write ````",
"operationId": "ContactsByIdTasksByTaskIdMessagesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Contact"
],
"summary": "Create Contact Task Message",
"description": "Creates a message and links it to the Task as well as any related Entities.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): task-read or task-write ````",
"operationId": "ContactsByIdTasksByTaskIdMessagesPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The body of the message containing the new message details.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
}
}
}
}
}
},
"/Contacts/{id}/tasks/{taskId}/messages/{messageId}": {
"get": {
"tags": [
"Contact"
],
"summary": "Get Contact Task Message Details",
"description": "Returns details about the message.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): task-read or task-write ````",
"operationId": "ContactsByIdTasksByTaskIdMessagesByMessageIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "messageId",
"in": "path",
"description": "The Id of the message.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageSummary"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageSummary"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageSummary"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageSummary"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageSummary"
}
}
}
}
}
}
},
"/Contacts/{id}/tasks/{taskId}/pin": {
"put": {
"tags": [
"Contact"
],
"summary": "Pin Contact Task",
"description": "Pins the task linked to the contact.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): contact-write and task-write ````",
"operationId": "ContactsByIdTasksByTaskIdPinPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Contacts/{id}/tasks/{taskId}/unarchive": {
"put": {
"tags": [
"Contact"
],
"summary": "Unarchive Contact Task",
"description": "Unarchives the task linked to the contact.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): contact-write and task-write ````",
"operationId": "ContactsByIdTasksByTaskIdUnarchivePut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Contacts/{id}/tasks/{taskId}/unpin": {
"put": {
"tags": [
"Contact"
],
"summary": "Unpin Contact Task",
"description": "Unpins the task linked to the contact.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): contact-write and task-write ````",
"operationId": "ContactsByIdTasksByTaskIdUnpinPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Contacts/{id}/webUser": {
"post": {
"tags": [
"Contact"
],
"summary": "Create Web User Account",
"description": "Creates a web user account for the contact.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): contact-write and webuser-write ````",
"operationId": "ContactsByIdWebUserPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The request body containing information about the new web user.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.CreateContactWebUserRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.CreateContactWebUserRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.CreateContactWebUserRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.CreateContactWebUserRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.CreateContactWebUserRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.CreateContactWebUserRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.CreateContactWebUserRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.CreateContactWebUserRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.CreateWebUserAccount.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.CreateWebUserAccount.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.CreateWebUserAccount.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.CreateWebUserAccount.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.CreateWebUserAccount.Result"
}
}
}
}
}
},
"get": {
"tags": [
"Contact"
],
"summary": "Get Web User Account Details",
"description": "Gets details about the Contact's Web User Account if one exists. Returns a NoContent if no such account exists.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): contact-read or contact-write ````",
"operationId": "ContactsByIdWebUserGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.WebUserAccountDetailsByEntity.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.WebUserAccountDetailsByEntity.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.WebUserAccountDetailsByEntity.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.WebUserAccountDetailsByEntity.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.WebUserAccountDetailsByEntity.Result"
}
}
}
}
}
}
},
"/Contacts/{id}/webUser/activate": {
"put": {
"tags": [
"Contact"
],
"summary": "Activate Contact Web User",
"description": "Activates the contact's existing Web User Account.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): contact-write and webuser-write ````",
"operationId": "ContactsByIdWebUserActivatePut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Contacts/{id}/webUser/availableProductInstances": {
"get": {
"tags": [
"Contact"
],
"summary": "Get Web User Account Available Product Instances List",
"description": "Gets a list of Product Instances not yet associated with the Contact's Web User Account.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): contact-read or contact-write ````",
"operationId": "ContactsByIdWebUserAvailableProductInstancesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of assignments to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of assignments to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "productId",
"in": "query",
"description": "Optional Id of the product to filter the list.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.WebUserAvailableProductInstances.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.WebUserAvailableProductInstances.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.WebUserAvailableProductInstances.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.WebUserAvailableProductInstances.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.WebUserAvailableProductInstances.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.WebUserAvailableProductInstances.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.WebUserAvailableProductInstances.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Contacts/{id}/webUser/deactivate": {
"put": {
"tags": [
"Contact"
],
"summary": "Deactivate Contact Web User",
"description": "Deactivates the contact's existing Web User Account.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): contact-write and webuser-write ````",
"operationId": "ContactsByIdWebUserDeactivatePut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Contacts/{id}/webUser/inviteWebUser": {
"post": {
"tags": [
"Contact"
],
"summary": "Invite Contact Web User",
"description": "Invites the contact to register as web user and assigns them a role.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): webuser-write ````",
"operationId": "ContactsByIdWebUserInviteWebUserPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "A model containing the email and role for the invite.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.ContactInviteWebUserRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.ContactInviteWebUserRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.ContactInviteWebUserRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.ContactInviteWebUserRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.ContactInviteWebUserRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.ContactInviteWebUserRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.ContactInviteWebUserRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.API.Models.ContactInviteWebUserRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Contacts/{id}/webUser/LogWebUserPasswordResetEmail": {
"put": {
"tags": [
"Contact"
],
"summary": "Log when a password reset email is sent to a Contact",
"description": "\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): webuser-write ````",
"operationId": "ContactsByIdWebUserLogWebUserPasswordResetEmailPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "Body of the request containing information about the WebUser account and the entity who \r\nrequested the password reset email.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.WebUserPasswordResetEmailRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.WebUserPasswordResetEmailRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.WebUserPasswordResetEmailRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.WebUserPasswordResetEmailRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.WebUserPasswordResetEmailRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.WebUserPasswordResetEmailRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.WebUserPasswordResetEmailRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.WebUserPasswordResetEmailRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Contacts/{id}/webUser/openAPICustomIntegration": {
"post": {
"tags": [
"Contact"
],
"summary": "Link to an OpenAPICustomIntegration",
"description": "Links the contact to an Open API Custom Integration.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): webuser-write ````",
"operationId": "ContactsByIdWebUserOpenAPICustomIntegrationPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "A model containing the Open API Custom Integration instance",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToOpenAPICustomIntegrationRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToOpenAPICustomIntegrationRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToOpenAPICustomIntegrationRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToOpenAPICustomIntegrationRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToOpenAPICustomIntegrationRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToOpenAPICustomIntegrationRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToOpenAPICustomIntegrationRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToOpenAPICustomIntegrationRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
},
"delete": {
"tags": [
"Contact"
],
"summary": "Delete link to OpenAPICustomIntegration",
"description": "Removes the link between the contact and the Open API Custom Integration.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): webuser-write ````",
"operationId": "ContactsByIdWebUserOpenAPICustomIntegrationDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "openAPICustomIntegrationProductInstanceId",
"in": "query",
"description": "The id of Open API Custom Integration instance to unlink",
"required": true,
"style": "form",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Contacts/{id}/webUser/productInstances": {
"get": {
"tags": [
"Contact"
],
"summary": "Get Web User Account Product Instances List",
"description": "Gets a list of Product Instances associated with the Contact's Web User Account.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): contact-read or contact-write ````",
"operationId": "ContactsByIdWebUserProductInstancesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of assignments to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of assignments to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.WebUserAccountProductInstanceListByOriginPairQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.WebUserAccountProductInstanceListByOriginPairQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.WebUserAccountProductInstanceListByOriginPairQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.WebUserAccountProductInstanceListByOriginPairQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.WebUserAccountProductInstanceListByOriginPairQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.WebUserAccountProductInstanceListByOriginPairQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.WebUserAccountProductInstanceListByOriginPairQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Contacts/{id}/webUser/rename": {
"put": {
"tags": [
"Contact"
],
"summary": "Rename Contact Web User",
"description": "Renames the contact's Web User Account.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): contact-write and webuser-write ````",
"operationId": "ContactsByIdWebUserRenamePut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "A model containing the new username",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.RenameWebUserRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.RenameWebUserRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.RenameWebUserRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.RenameWebUserRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.RenameWebUserRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.RenameWebUserRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.RenameWebUserRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.RenameWebUserRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Contacts/{id}/webUser/resetPassword": {
"put": {
"tags": [
"Contact"
],
"summary": "Reset Contact Web User Password",
"description": "Resets the password of the contact requiring the user to change their password at next login.\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): contact-write and webuser-write ````",
"operationId": "ContactsByIdWebUserResetPasswordPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "A model containing the new temporary password",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.ResetWebUserPasswordRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.ResetWebUserPasswordRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.ResetWebUserPasswordRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.ResetWebUserPasswordRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.ResetWebUserPasswordRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.ResetWebUserPasswordRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.ResetWebUserPasswordRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.ResetWebUserPasswordRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
},
"200": {
"description": "Password successfully reset"
}
}
}
},
"/Contacts/{id}/webUser/unlock": {
"put": {
"tags": [
"Contact"
],
"summary": "Unlocks Contact Web User.",
"description": "Unlocks the contact.\r\nLocking occurs when a user had multiple unsuccessful login attempts and in result,\r\nfurther login attempts are disabled.\r\nWhen unlocked, a web user is enabled to perform login attempts again.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): webuser-write ````",
"operationId": "ContactsByIdWebUserUnlockPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Contacts/{id}/webUser/webCenter": {
"post": {
"tags": [
"Contact"
],
"summary": "Link To Web Center",
"description": "Links the contact to Web Center and assigns them a role.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): webuser-write ````",
"operationId": "ContactsByIdWebUserWebCenterPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "A model containing the new Web Center instance and role",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToWebCenterRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToWebCenterRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToWebCenterRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToWebCenterRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToWebCenterRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToWebCenterRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToWebCenterRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToWebCenterRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
},
"delete": {
"tags": [
"Contact"
],
"summary": "Delete Link To Web Center",
"description": "Removes the link between the contact and Web Center.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): webuser-write ````",
"operationId": "ContactsByIdWebUserWebCenterDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Contacts/{id}/webUser/webCenter/availableRoles": {
"get": {
"tags": [
"Contact"
],
"summary": "Get Available Web Center Role List",
"description": "Gets a list of Web Center roles available to the contact.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): webuser-read or webuser-write ````",
"operationId": "ContactsByIdWebUserWebCenterAvailableRolesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "webCenterProductInstanceId",
"in": "query",
"description": "The Product Instance Id of the Web Center Instance",
"required": true,
"style": "form",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.WebCenterRoleList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.WebCenterRoleList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.WebCenterRoleList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.WebCenterRoleList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.WebCenterRoleList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.WebCenterRoleList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.WebCenterRoleList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Contacts/{id}/webUser/webCenter/role": {
"put": {
"tags": [
"Contact"
],
"summary": "Change Web Center Role",
"description": "Changes the contact's Web Center role.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): contact-write and webuser-write ````",
"operationId": "ContactsByIdWebUserWebCenterRolePut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the contact",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "A model containing the new role",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.ChangeWebCenterRoleRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.ChangeWebCenterRoleRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.ChangeWebCenterRoleRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.ChangeWebCenterRoleRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.ChangeWebCenterRoleRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.ChangeWebCenterRoleRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.ChangeWebCenterRoleRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.ChangeWebCenterRoleRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Content/Cards": {
"post": {
"tags": [
"Cards"
],
"summary": "Creates a card.",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): Reserved For TempWorks' Products Only ````",
"operationId": "ContentCardsPost",
"requestBody": {
"description": "The details of the card to create.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.CustomContent.RequestModels.CreateCardRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.CustomContent.RequestModels.CreateCardRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.CustomContent.RequestModels.CreateCardRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.CustomContent.RequestModels.CreateCardRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.CustomContent.RequestModels.CreateCardRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.CustomContent.RequestModels.CreateCardRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.CustomContent.RequestModels.CreateCardRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.CustomContent.RequestModels.CreateCardRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.CustomContent.CreateCard.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.CustomContent.CreateCard.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.CustomContent.CreateCard.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.CustomContent.CreateCard.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.CustomContent.CreateCard.Result"
}
}
}
}
}
},
"get": {
"tags": [
"Cards"
],
"summary": "Get list of cards to manage",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): Reserved For TempWorks' Products Only ````",
"operationId": "ContentCardsGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Models.Card, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Models.Card, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Models.Card, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Models.Card, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Models.Card, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Models.Card, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Models.Card, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Content/Cards/{cardId}": {
"get": {
"tags": [
"Cards"
],
"summary": "Gets a card by cardId.",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "ContentCardsByCardIdGet",
"parameters": [
{
"name": "cardId",
"in": "path",
"description": "The card id.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.CustomContent.CardDetails.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.CustomContent.CardDetails.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.CustomContent.CardDetails.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.CustomContent.CardDetails.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.CustomContent.CardDetails.Result"
}
}
}
},
"404": {
"description": "Not Found"
}
}
},
"put": {
"tags": [
"Cards"
],
"summary": "Updates a card.",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): Reserved For TempWorks' Products Only ````",
"operationId": "ContentCardsByCardIdPut",
"parameters": [
{
"name": "cardId",
"in": "path",
"description": "The database id of the card to update.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The details of the card to update.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.CustomContent.RequestModels.UpdateCardRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.CustomContent.RequestModels.UpdateCardRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.CustomContent.RequestModels.UpdateCardRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.CustomContent.RequestModels.UpdateCardRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.CustomContent.RequestModels.UpdateCardRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.CustomContent.RequestModels.UpdateCardRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.CustomContent.RequestModels.UpdateCardRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.CustomContent.RequestModels.UpdateCardRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
},
"delete": {
"tags": [
"Cards"
],
"summary": "Deletes a card.",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): Reserved For TempWorks' Products Only ````",
"operationId": "ContentCardsByCardIdDelete",
"parameters": [
{
"name": "cardId",
"in": "path",
"description": "The database id of the card to delete.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Content/Cards/{cardId}/publish": {
"put": {
"tags": [
"Cards"
],
"summary": "Publishes a card.",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): Reserved For TempWorks' Products Only ````",
"operationId": "ContentCardsByCardIdPublishPut",
"parameters": [
{
"name": "cardId",
"in": "path",
"description": "The card id.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Content/Cards/available": {
"get": {
"tags": [
"Cards"
],
"summary": "Gets the cards visible by the hierarchy id.",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "ContentCardsAvailableGet",
"parameters": [
{
"name": "hierId",
"in": "query",
"description": "The hierarchy id.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomContent.CardsByHier.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomContent.CardsByHier.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomContent.CardsByHier.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomContent.CardsByHier.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomContent.CardsByHier.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomContent.CardsByHier.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomContent.CardsByHier.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Content/Cards/eligibleForPage": {
"get": {
"tags": [
"Cards"
],
"summary": "Gets a list of cards eligible to be added to a page based on hierarchy and origin type.",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): Reserved For TempWorks' Products Only ````",
"operationId": "ContentCardsEligibleForPageGet",
"parameters": [
{
"name": "PageHierId",
"in": "query",
"description": "The hierarchy Id of the page. The cards suitable for the page are cards on the same hierarchy level of the page or above.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "PageOriginTypeId",
"in": "query",
"description": "The origin type of the page. The cards suitable for the page should be of the same origin type as the page.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Skip",
"in": "query",
"description": "The number of cards to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Take",
"in": "query",
"description": "The number of cards to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomContent.EligibleCardsForPage.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomContent.EligibleCardsForPage.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomContent.EligibleCardsForPage.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomContent.EligibleCardsForPage.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomContent.EligibleCardsForPage.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomContent.EligibleCardsForPage.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomContent.EligibleCardsForPage.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Content/Cards/originType/{originTypeId}": {
"get": {
"tags": [
"Cards"
],
"summary": "Get cards by origin type",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "ContentCardsOriginTypeByOriginTypeIdGet",
"parameters": [
{
"name": "originTypeId",
"in": "path",
"description": "The origin type to obtain cards for. Supported origin types are 1 (Employee), 2 (Customer), 3 (Contact), 8 (Order), and 14 (Assignment).",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Models.CardSummary, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Models.CardSummary, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Models.CardSummary, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Models.CardSummary, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Models.CardSummary, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Models.CardSummary, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Models.CardSummary, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Content/Pages": {
"post": {
"tags": [
"Pages"
],
"summary": "Creates a page.",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): Reserved For TempWorks' Products Only ````",
"operationId": "ContentPagesPost",
"requestBody": {
"description": "The details to create a page and a list of cards to be assigned to it.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.CustomContent.RequestModels.CreatePageRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.CustomContent.RequestModels.CreatePageRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.CustomContent.RequestModels.CreatePageRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.CustomContent.RequestModels.CreatePageRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.CustomContent.RequestModels.CreatePageRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.CustomContent.RequestModels.CreatePageRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.CustomContent.RequestModels.CreatePageRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.CustomContent.RequestModels.CreatePageRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.CustomContent.CreatePage.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.CustomContent.CreatePage.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.CustomContent.CreatePage.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.CustomContent.CreatePage.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.CustomContent.CreatePage.Result"
}
}
}
}
}
},
"get": {
"tags": [
"Pages"
],
"summary": "Get pages available to be vied/managed by the current user.",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): Reserved For TempWorks' Products Only ````",
"operationId": "ContentPagesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomContent.PageList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomContent.PageList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomContent.PageList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomContent.PageList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomContent.PageList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomContent.PageList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomContent.PageList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Content/Pages/{pageId}": {
"delete": {
"tags": [
"Pages"
],
"summary": "Deletes a page.",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): Reserved For TempWorks' Products Only ````",
"operationId": "ContentPagesByPageIdDelete",
"parameters": [
{
"name": "pageId",
"in": "path",
"description": "The id of the page.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
},
"get": {
"tags": [
"Pages"
],
"summary": "Get page details and its cards.",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): Reserved For TempWorks' Products Only ````",
"operationId": "ContentPagesByPageIdGet",
"parameters": [
{
"name": "pageId",
"in": "path",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.CustomContent.PageDetails.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.CustomContent.PageDetails.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.CustomContent.PageDetails.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.CustomContent.PageDetails.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.CustomContent.PageDetails.Result"
}
}
}
}
}
},
"put": {
"tags": [
"Pages"
],
"summary": "Updates a page.",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): Reserved For TempWorks' Products Only ````",
"operationId": "ContentPagesByPageIdPut",
"parameters": [
{
"name": "pageId",
"in": "path",
"description": "The page id.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The page request. The cards in the request will replace all existing.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.CustomContent.RequestModels.UpdatePageRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.CustomContent.RequestModels.UpdatePageRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.CustomContent.RequestModels.UpdatePageRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.CustomContent.RequestModels.UpdatePageRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.CustomContent.RequestModels.UpdatePageRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.CustomContent.RequestModels.UpdatePageRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.CustomContent.RequestModels.UpdatePageRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.CustomContent.RequestModels.UpdatePageRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Content/Pages/{pageId}/cards": {
"get": {
"tags": [
"Pages"
],
"summary": "Get all cards in a page.",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "ContentPagesByPageIdCardsGet",
"parameters": [
{
"name": "pageId",
"in": "path",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomContent.CardsInPage.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomContent.CardsInPage.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomContent.CardsInPage.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomContent.CardsInPage.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomContent.CardsInPage.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomContent.CardsInPage.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomContent.CardsInPage.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Content/Pages/{pageId}/publish": {
"put": {
"tags": [
"Pages"
],
"summary": "Publishes a page.",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): Reserved For TempWorks' Products Only ````",
"operationId": "ContentPagesByPageIdPublishPut",
"parameters": [
{
"name": "pageId",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Content/Pages/available": {
"get": {
"tags": [
"Pages"
],
"summary": "Gets a list of pages with their cards.\r\nOnly return pages and cards that are both visible to the specified hier.",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): Reserved For TempWorks' Products Only ````",
"operationId": "ContentPagesAvailableGet",
"parameters": [
{
"name": "hierId",
"in": "query",
"description": "HierId under for which to retrieve pages with cards",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomContent.PagesWithCardsByHier.PageBasicInfo, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomContent.PagesWithCardsByHier.PageBasicInfo, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomContent.PagesWithCardsByHier.PageBasicInfo, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomContent.PagesWithCardsByHier.PageBasicInfo, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomContent.PagesWithCardsByHier.PageBasicInfo, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomContent.PagesWithCardsByHier.PageBasicInfo, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomContent.PagesWithCardsByHier.PageBasicInfo, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Content/Pages/routes": {
"get": {
"tags": [
"Pages"
],
"summary": "Get pages(tabs/routes) available to be viewed by the current user.",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "ContentPagesRoutesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomContent.ContentRouteList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomContent.ContentRouteList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomContent.ContentRouteList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomContent.ContentRouteList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomContent.ContentRouteList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomContent.ContentRouteList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomContent.ContentRouteList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Content/Pages/validate": {
"get": {
"tags": [
"Pages"
],
"summary": "Validates the page related data, but does not validate card related data.",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): Reserved For TempWorks' Products Only ````",
"operationId": "ContentPagesValidateGet",
"parameters": [
{
"name": "PageId",
"in": "query",
"description": "The page id, if the page exists already.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "HierId",
"in": "query",
"description": "The hierarchy of the page.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "OriginTypeId",
"in": "query",
"description": "The origin type id of the page.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Name",
"in": "query",
"description": "The name of the page.",
"required": true,
"style": "form",
"schema": {
"maxLength": 50,
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
},
"application/xml": {
"schema": {
"type": "boolean"
}
},
"text/xml": {
"schema": {
"type": "boolean"
}
}
}
}
}
}
},
"/Customers": {
"post": {
"tags": [
"Customer"
],
"summary": "Create Customer",
"description": "Creates a new customer in the system and if needed will also create the worksite.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersPost",
"requestBody": {
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Customers.CreateCustomer.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Customers.CreateCustomer.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Customers.CreateCustomer.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Customers.CreateCustomer.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Customers.CreateCustomer.Result"
}
}
}
}
}
}
},
"/Customers/{customerId}/messages/{messageId}": {
"put": {
"tags": [
"Customer"
],
"summary": "Update Message",
"description": "Updates a message and links it to the customer.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByCustomerIdMessagesByMessageIdPut",
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "messageId",
"in": "path",
"description": "The Id of the message",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The body of the request containing the information required to update the message.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.UpdateMessageWithLinkedDocumentsRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.UpdateMessageWithLinkedDocumentsRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.UpdateMessageWithLinkedDocumentsRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.UpdateMessageWithLinkedDocumentsRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.UpdateMessageWithLinkedDocumentsRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.UpdateMessageWithLinkedDocumentsRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.UpdateMessageWithLinkedDocumentsRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.UpdateMessageWithLinkedDocumentsRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.UpdateContactMessageResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.UpdateContactMessageResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.UpdateContactMessageResult"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.UpdateContactMessageResult"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.UpdateContactMessageResult"
}
}
}
}
}
}
},
"/Customers/{customerId}/messages/{messageId}/documents": {
"post": {
"tags": [
"Customer"
],
"summary": "Upload document to a message",
"description": "\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByCustomerIdMessagesByMessageIdDocumentsPost",
"parameters": [
{
"name": "customerId",
"in": "path",
"description": "The Id of the customer.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "messageId",
"in": "path",
"description": "The Id of the message.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"required": [
"DocumentName",
"DocumentTypeId"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
},
"DocumentName": {
"type": "string"
},
"DocumentTypeId": {
"type": "integer",
"format": "int32"
},
"Description": {
"maxLength": 255,
"type": "string"
},
"ExpirationDate": {
"type": "string",
"format": "date-time"
},
"Version": {
"type": "string"
}
}
},
"encoding": {
"File": {
"style": "form"
},
"DocumentName": {
"style": "form"
},
"DocumentTypeId": {
"style": "form"
},
"Description": {
"style": "form"
},
"ExpirationDate": {
"style": "form"
},
"Version": {
"style": "form"
}
}
}
}
},
"responses": {
"201": {
"description": "Id of the new document.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
}
}
}
}
}
},
"/Customers/{id}": {
"get": {
"tags": [
"Customer"
],
"summary": "Get Basic Details",
"description": "Gets basic detail information about the specified customer.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerDetailsQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerDetailsQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerDetailsQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerDetailsQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerDetailsQuery.Result"
}
}
}
}
}
},
"patch": {
"tags": [
"Customer"
],
"summary": "Patch Customer",
"description": "\r\n\r\n Allows for Json patching to be performed against customer fields.\r\n More information about PATCHING, see https://developer.ontempworks.com/docs/your-request\r\n \r\n\r\n\r\n Valid Patch paths: /CustomerName(string), /DepartmentName(string), /CustomerStatusId(string), /WorksiteId(int?), /Website(string), /ParentCustomerId(long?), /RootCustomerId(long?), /IsMonthlyBill(bool), /CreditLimit(decimal), /Note(string), /DateActivated(DateTime), /BranchId(int), /PrimaryPhoneNumberContactMethodId(int?), /PrimaryEmailAddressContactMethodId(int?), /PrimaryMessageId(long?)\r\n \n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdPatch",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "A Json array of patch operations to be performed.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":"NewSampleName","path":"/CustomerName","op":"replace"},{"value":"SanmpleNote","path":"/Note","op":"add"},{"path":"/Note","op":"remove"},{"path":"/Note","op":"copy","from":"/Website"},{"path":"/Note","op":"move","from":"/Website"},{"value":"NewSampleName","path":"/CustomerName","op":"test"}]
},
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":"NewSampleName","path":"/CustomerName","op":"replace"},{"value":"SanmpleNote","path":"/Note","op":"add"},{"path":"/Note","op":"remove"},{"path":"/Note","op":"copy","from":"/Website"},{"path":"/Note","op":"move","from":"/Website"},{"value":"NewSampleName","path":"/CustomerName","op":"test"}]
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":"NewSampleName","path":"/CustomerName","op":"replace"},{"value":"SanmpleNote","path":"/Note","op":"add"},{"path":"/Note","op":"remove"},{"path":"/Note","op":"copy","from":"/Website"},{"path":"/Note","op":"move","from":"/Website"},{"value":"NewSampleName","path":"/CustomerName","op":"test"}]
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":"NewSampleName","path":"/CustomerName","op":"replace"},{"value":"SanmpleNote","path":"/Note","op":"add"},{"path":"/Note","op":"remove"},{"path":"/Note","op":"copy","from":"/Website"},{"path":"/Note","op":"move","from":"/Website"},{"value":"NewSampleName","path":"/CustomerName","op":"test"}]
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":"NewSampleName","path":"/CustomerName","op":"replace"},{"value":"SanmpleNote","path":"/Note","op":"add"},{"path":"/Note","op":"remove"},{"path":"/Note","op":"copy","from":"/Website"},{"path":"/Note","op":"move","from":"/Website"},{"value":"NewSampleName","path":"/CustomerName","op":"test"}]
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": "\r\n \r\n \r\n replace\r\n /CustomerName\r\n NewSampleName\r\n \r\n \r\n \r\n add\r\n /Note\r\n SanmpleNote\r\n \r\n \r\n \r\n remove\r\n /Note\r\n \r\n \r\n \r\n /Website\r\n copy\r\n /Note\r\n \r\n \r\n \r\n /Website\r\n move\r\n /Note\r\n \r\n \r\n \r\n \r\n test\r\n /CustomerName\r\n NewSampleName\r\n \r\n"
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": "\r\n \r\n \r\n replace\r\n /CustomerName\r\n NewSampleName\r\n \r\n \r\n \r\n add\r\n /Note\r\n SanmpleNote\r\n \r\n \r\n \r\n remove\r\n /Note\r\n \r\n \r\n \r\n /Website\r\n copy\r\n /Note\r\n \r\n \r\n \r\n /Website\r\n move\r\n /Note\r\n \r\n \r\n \r\n \r\n test\r\n /CustomerName\r\n NewSampleName\r\n \r\n"
},
"application/*+xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": "\r\n \r\n \r\n replace\r\n /CustomerName\r\n NewSampleName\r\n \r\n \r\n \r\n add\r\n /Note\r\n SanmpleNote\r\n \r\n \r\n \r\n remove\r\n /Note\r\n \r\n \r\n \r\n /Website\r\n copy\r\n /Note\r\n \r\n \r\n \r\n /Website\r\n move\r\n /Note\r\n \r\n \r\n \r\n \r\n test\r\n /CustomerName\r\n NewSampleName\r\n \r\n"
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Customers/{id}/absenceReasons": {
"get": {
"tags": [
"Customer"
],
"summary": "Get Customer Absence Reasons",
"description": "Gets a paged list of customer absence reasons ordered by the AbsenceReason field.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdAbsenceReasonsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "active",
"in": "query",
"description": "Optional filter on the active property.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.AbsenceReasons.CustomerAbsenceReasonsQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.AbsenceReasons.CustomerAbsenceReasonsQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.AbsenceReasons.CustomerAbsenceReasonsQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.AbsenceReasons.CustomerAbsenceReasonsQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.AbsenceReasons.CustomerAbsenceReasonsQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.AbsenceReasons.CustomerAbsenceReasonsQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.AbsenceReasons.CustomerAbsenceReasonsQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Customer"
],
"summary": "Create Customer Absence Reason",
"description": "Creates a new absence reason for the specified customer. The absence reason must be unique for that customer.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdAbsenceReasonsPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The request object to be used to create the absence reason.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CustomerAbsenceReasonRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CustomerAbsenceReasonRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CustomerAbsenceReasonRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CustomerAbsenceReasonRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CustomerAbsenceReasonRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CustomerAbsenceReasonRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CustomerAbsenceReasonRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CustomerAbsenceReasonRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.AbsenceReasons.CreateCustomerAbsenceReasonCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.AbsenceReasons.CreateCustomerAbsenceReasonCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.AbsenceReasons.CreateCustomerAbsenceReasonCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.AbsenceReasons.CreateCustomerAbsenceReasonCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.AbsenceReasons.CreateCustomerAbsenceReasonCommand.Result"
}
}
}
}
}
}
},
"/Customers/{id}/absenceReasons/{reasonId}": {
"get": {
"tags": [
"Customer"
],
"summary": "Get Customer Absence Reason",
"description": "Gets the specified Absence Reason for the specified Customer.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdAbsenceReasonsByReasonIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "reasonId",
"in": "path",
"description": "The id of the customer absence reason",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.AbsenceReasons.CustomerAbsenceReasonsQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.AbsenceReasons.CustomerAbsenceReasonsQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.AbsenceReasons.CustomerAbsenceReasonsQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.AbsenceReasons.CustomerAbsenceReasonsQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.AbsenceReasons.CustomerAbsenceReasonsQuery.Result"
}
}
}
}
}
},
"delete": {
"tags": [
"Customer"
],
"summary": "Delete Customer Absence Reason",
"description": "Deletes an absence reason for the specified customer.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdAbsenceReasonsByReasonIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "reasonId",
"in": "path",
"description": "The Id of the absence reason to delete.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
},
"put": {
"tags": [
"Customer"
],
"summary": "Update Customer Absence Reason",
"description": "Updates an absence reason for the specified customer. Absence reason must be unique for that customer.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdAbsenceReasonsByReasonIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "reasonId",
"in": "path",
"description": "The Id of the customer absence reason",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The request object to be used to update the absence reason.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CustomerAbsenceReasonRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CustomerAbsenceReasonRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CustomerAbsenceReasonRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CustomerAbsenceReasonRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CustomerAbsenceReasonRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CustomerAbsenceReasonRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CustomerAbsenceReasonRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CustomerAbsenceReasonRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Customers/{id}/address": {
"put": {
"tags": [
"Customer"
],
"summary": "Update Address",
"description": "Updates the specified customer's address. If the address is in the United States, the system will validate it against the address \r\nstandardization service. This validation can be bypassed by setting BypassAddressValidationService to true.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdAddressPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The request body containing the updated address values.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerAddressRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerAddressRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerAddressRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerAddressRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerAddressRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerAddressRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerAddressRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerAddressRequest"
}
}
}
},
"responses": {
"204": {
"description": "The request succeeded."
},
"520": {
"description": "The address standardization service is encountering server issues. Try again later."
},
"521": {
"description": "The address standardization service is encountering issues with the request."
}
}
}
},
"/Customers/{id}/assignments": {
"get": {
"tags": [
"Customer"
],
"summary": "Get Customer Assignments",
"description": "Gets a list of assignments for the specified customer. The assignments are ordered by start date from newest to the oldest and then by job title.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdAssignmentsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "Skip",
"in": "query",
"description": "The number of assignments to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Take",
"in": "query",
"description": "The number of assignments to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "IsActive",
"in": "query",
"description": "Searches for assignments that are active or inactive based upon the provided value. Leave null to return all.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "IsMasterView",
"in": "query",
"description": "If set to true, assignments for the specified customer and its departments will be returned.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "StartDate",
"in": "query",
"description": "An optional parameter. Only assignments for which the employee was working during or after \r\nthe specified date will be returned.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "EndDate",
"in": "query",
"description": "An optional parameter. Only assignments for which the employee was working during or before \r\nthe specified date will be returned.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "CanGenerateTimecard",
"in": "query",
"description": "Optional filter which limits the list of assignments to those which can generate a timecard or not. \r\nDo not specify a value to return all",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "OrderBy",
"in": "query",
"description": "Used to order the results by one of the returned columns.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "OrderByAscending",
"in": "query",
"description": "Used to specify the sort order. If left null, the system will order ascending automatically.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "AssignmentStatusId",
"in": "query",
"description": "Optional filter for assignment status Id. Ref: /datalists/assignmentStatuses",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Assignments.AssignmentSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Assignments.AssignmentSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Assignments.AssignmentSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Assignments.AssignmentSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Assignments.AssignmentSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Assignments.AssignmentSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Assignments.AssignmentSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Customers/{id}/billingAddress": {
"put": {
"tags": [
"Customer"
],
"summary": "Update Billing Address",
"description": "Updates the specified customers's billing address. If the address is in the United States, the system will validate it against\r\nthe address standardization service. This validation can be bypassed by setting BypassAddressValidationService to true.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdBillingAddressPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The request body containing the updated address values.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerBillingAddressRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerBillingAddressRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerBillingAddressRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerBillingAddressRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerBillingAddressRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerBillingAddressRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerBillingAddressRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerBillingAddressRequest"
}
}
}
},
"responses": {
"204": {
"description": "The request succeeded."
},
"520": {
"description": "The address standardization service is encountering server issues. Try again later."
},
"521": {
"description": "The address standardization service is encountering issues with the request."
}
}
}
},
"/Customers/{id}/billingSetup": {
"get": {
"tags": [
"Customer"
],
"summary": "Get Customer Billing Setup",
"description": "Gets information about how invoices are created, processed, and then distributed.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdBillingSetupGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.BillingSetup.CustomerBillingSetupQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.BillingSetup.CustomerBillingSetupQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.BillingSetup.CustomerBillingSetupQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.BillingSetup.CustomerBillingSetupQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.BillingSetup.CustomerBillingSetupQuery.Result"
}
}
}
}
}
},
"put": {
"tags": [
"Customer"
],
"summary": "Update Customer Billing Setup",
"description": "Update information about how invoices are created, processed, and then distributed.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdBillingSetupPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The request body containing the new values for the customer billing setup.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerBillingSetupRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerBillingSetupRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerBillingSetupRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerBillingSetupRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerBillingSetupRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerBillingSetupRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerBillingSetupRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerBillingSetupRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Customers/{id}/billingSetup/inheritedRecipients": {
"post": {
"tags": [
"Customer"
],
"summary": "Create Customer Invoice Inherited Recipients",
"description": "Creates inherited invoice recipients from the parent customer.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdBillingSetupInheritedRecipientsPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Customers/{id}/billingSetup/lineItemDetails": {
"get": {
"tags": [
"Customer"
],
"summary": "Get Customer Invoice Line Item Details",
"description": "Gets a list of line item details to be included on each line item in the invoice. The list is sorted by LineItemDetail.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdBillingSetupLineItemDetailsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "Number of line item details to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "Number of line item details to take. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.BillingSetup.CustomerInvoiceLineItemDetailsQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.BillingSetup.CustomerInvoiceLineItemDetailsQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.BillingSetup.CustomerInvoiceLineItemDetailsQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.BillingSetup.CustomerInvoiceLineItemDetailsQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.BillingSetup.CustomerInvoiceLineItemDetailsQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.BillingSetup.CustomerInvoiceLineItemDetailsQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.BillingSetup.CustomerInvoiceLineItemDetailsQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Customer"
],
"summary": "Add Customer Invoice Line Item Detail",
"description": "Adds the specified LineItemDetail to the customer's list of lines to include on the invoice.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdBillingSetupLineItemDetailsPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The body of the request containing the line item detail to add.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerLineItemDetailRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerLineItemDetailRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerLineItemDetailRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerLineItemDetailRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerLineItemDetailRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerLineItemDetailRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerLineItemDetailRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerLineItemDetailRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.BillingSetup.CreateCustomerInvoiceLineItemDetailCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.BillingSetup.CreateCustomerInvoiceLineItemDetailCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.BillingSetup.CreateCustomerInvoiceLineItemDetailCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.BillingSetup.CreateCustomerInvoiceLineItemDetailCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.BillingSetup.CreateCustomerInvoiceLineItemDetailCommand.Result"
}
}
}
}
}
}
},
"/Customers/{id}/billingSetup/lineItemDetails/{customerLineItemDetailId}": {
"delete": {
"tags": [
"Customer"
],
"summary": "Delete Customer Invoice Line Item Detail",
"description": "Removes the specified LineItemDetail from the customer's list of lines to include on the invoice.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdBillingSetupLineItemDetailsByCustomerLineItemDetailIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "customerLineItemDetailId",
"in": "path",
"description": "The Id of line item detail to remove",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Customers/{id}/calculateGrossProfit": {
"post": {
"tags": [
"Customer"
],
"summary": "Calculate Gross Profit for a Customer",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdCalculateGrossProfitPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "Request Body",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.CalculateGrossProfitRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.CalculateGrossProfitRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.CalculateGrossProfitRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.CalculateGrossProfitRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.CalculateGrossProfitRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.CalculateGrossProfitRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.CalculateGrossProfitRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.CalculateGrossProfitRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.CalculateGrossProfitResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.CalculateGrossProfitResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.CalculateGrossProfitResult"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.CalculateGrossProfitResult"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.CalculateGrossProfitResult"
}
}
}
}
}
}
},
"/Customers/{id}/candidates": {
"post": {
"tags": [
"Customer"
],
"summary": "Create Customer Candidate",
"description": "Add specified employee as an absence candidate for specified customer.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdCandidatesPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The request object containing the employeeId",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerAbsenceCandidateRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerAbsenceCandidateRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerAbsenceCandidateRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerAbsenceCandidateRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerAbsenceCandidateRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerAbsenceCandidateRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerAbsenceCandidateRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerAbsenceCandidateRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.Candidate.CreateCustomerCandidateCommand.CreateCustomerCandidateResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.Candidate.CreateCustomerCandidateCommand.CreateCustomerCandidateResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.Candidate.CreateCustomerCandidateCommand.CreateCustomerCandidateResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.Candidate.CreateCustomerCandidateCommand.CreateCustomerCandidateResponse"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.Candidate.CreateCustomerCandidateCommand.CreateCustomerCandidateResponse"
}
}
}
}
}
},
"get": {
"tags": [
"Customer"
],
"summary": "Get Customer Candidates",
"description": "Get a paged list of customer candidates ordered by the employee last name, first name and initial.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdCandidatesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.Candidate.CustomerCandidatesQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.Candidate.CustomerCandidatesQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.Candidate.CustomerCandidatesQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.Candidate.CustomerCandidatesQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.Candidate.CustomerCandidatesQuery.Result"
}
}
}
}
}
}
},
"/Customers/{id}/candidates/{candidateId}": {
"get": {
"tags": [
"Customer"
],
"summary": "Get Customer Candidate",
"description": "Get a customer candidate.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdCandidatesByCandidateIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "candidateId",
"in": "path",
"description": "The Id of the candidate",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.Candidate.CustomerCandidatesQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.Candidate.CustomerCandidatesQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.Candidate.CustomerCandidatesQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.Candidate.CustomerCandidatesQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.Candidate.CustomerCandidatesQuery.Result"
}
}
}
}
}
},
"delete": {
"tags": [
"Customer"
],
"summary": "Delete Customer Candidate",
"description": "Deletes a customer candidate.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdCandidatesByCandidateIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the Customer.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "candidateId",
"in": "path",
"description": "The Id of the Candidate",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Customers/{id}/contactmethods": {
"post": {
"tags": [
"Customer"
],
"summary": "Create Contact Method",
"description": "Creates a contact method for the specified customer.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdContactmethodsPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The contact method to create",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMethods.CreateEntityContactMethodRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMethods.CreateEntityContactMethodRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMethods.CreateEntityContactMethodRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMethods.CreateEntityContactMethodRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMethods.CreateEntityContactMethodRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMethods.CreateEntityContactMethodRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMethods.CreateEntityContactMethodRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMethods.CreateEntityContactMethodRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.ContactMethods.CreateEntityContactMethodCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.ContactMethods.CreateEntityContactMethodCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.ContactMethods.CreateEntityContactMethodCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.ContactMethods.CreateEntityContactMethodCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.ContactMethods.CreateEntityContactMethodCommand.Result"
}
}
}
}
}
}
},
"/Customers/{id}/contactMethods": {
"get": {
"tags": [
"Customer"
],
"summary": "Get Contact Method List",
"description": "Gets a list of contact methods for the specified customer. The contact methods are ordered alphabetically by their type.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdContactMethodsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of contact methods to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of contact methods to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.ContactMethods.EntityContactMethod, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.ContactMethods.EntityContactMethod, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.ContactMethods.EntityContactMethod, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.ContactMethods.EntityContactMethod, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.ContactMethods.EntityContactMethod, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.ContactMethods.EntityContactMethod, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.ContactMethods.EntityContactMethod, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Customers/{id}/contactmethods/{contactMethodId}": {
"delete": {
"tags": [
"Customer"
],
"summary": "Delete Contact Method",
"description": "Deletes a contact method from the specified customer.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdContactmethodsByContactMethodIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "contactMethodId",
"in": "path",
"description": "The Id of the contact method",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
},
"patch": {
"tags": [
"Customer"
],
"summary": "Patch Contact Method",
"description": "\r\n\r\n Performs the specified patching operations against a contact method from the specified customer.\r\n More information about PATCHING, see https://developer.ontempworks.com/docs/your-request\r\n \r\n\r\n\r\n Valid Patch paths: /ContactMethodTypeId(short), /ContactMethod(string), /IsActive(bool), /Notes(string), /WhenAvailable(string), /AreaCode(int), /ProviderId(int), /CountryCallingCode(int?), /IsPinned(bool)\r\n \n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdContactmethodsByContactMethodIdPatch",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "contactMethodId",
"in": "path",
"description": "The Id of the contact method",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The list of patch operations to perform on the contact method",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":"6514520366","path":"/ContactMethod","op":"replace"},{"value":1,"path":"/CountryCallingCode","op":"add"},{"path":"/CountryCallingCode","op":"remove"},{"path":"/Notes","op":"copy","from":"/CountryCallingCode"},{"path":"/Notes","op":"move","from":"/CountryCallingCode"},{"value":"6514520366","path":"/ContactMethod","op":"test"}]
},
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":"6514520366","path":"/ContactMethod","op":"replace"},{"value":1,"path":"/CountryCallingCode","op":"add"},{"path":"/CountryCallingCode","op":"remove"},{"path":"/Notes","op":"copy","from":"/CountryCallingCode"},{"path":"/Notes","op":"move","from":"/CountryCallingCode"},{"value":"6514520366","path":"/ContactMethod","op":"test"}]
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":"6514520366","path":"/ContactMethod","op":"replace"},{"value":1,"path":"/CountryCallingCode","op":"add"},{"path":"/CountryCallingCode","op":"remove"},{"path":"/Notes","op":"copy","from":"/CountryCallingCode"},{"path":"/Notes","op":"move","from":"/CountryCallingCode"},{"value":"6514520366","path":"/ContactMethod","op":"test"}]
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":"6514520366","path":"/ContactMethod","op":"replace"},{"value":1,"path":"/CountryCallingCode","op":"add"},{"path":"/CountryCallingCode","op":"remove"},{"path":"/Notes","op":"copy","from":"/CountryCallingCode"},{"path":"/Notes","op":"move","from":"/CountryCallingCode"},{"value":"6514520366","path":"/ContactMethod","op":"test"}]
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":"6514520366","path":"/ContactMethod","op":"replace"},{"value":1,"path":"/CountryCallingCode","op":"add"},{"path":"/CountryCallingCode","op":"remove"},{"path":"/Notes","op":"copy","from":"/CountryCallingCode"},{"path":"/Notes","op":"move","from":"/CountryCallingCode"},{"value":"6514520366","path":"/ContactMethod","op":"test"}]
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": "\r\n \r\n \r\n replace\r\n /ContactMethod\r\n 6514520366\r\n \r\n \r\n \r\n add\r\n /CountryCallingCode\r\n 1\r\n \r\n \r\n \r\n remove\r\n /CountryCallingCode\r\n \r\n \r\n \r\n /CountryCallingCode\r\n copy\r\n /Notes\r\n \r\n \r\n \r\n /CountryCallingCode\r\n move\r\n /Notes\r\n \r\n \r\n \r\n \r\n test\r\n /ContactMethod\r\n 6514520366\r\n \r\n"
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": "\r\n \r\n \r\n replace\r\n /ContactMethod\r\n 6514520366\r\n \r\n \r\n \r\n add\r\n /CountryCallingCode\r\n 1\r\n \r\n \r\n \r\n remove\r\n /CountryCallingCode\r\n \r\n \r\n \r\n /CountryCallingCode\r\n copy\r\n /Notes\r\n \r\n \r\n \r\n /CountryCallingCode\r\n move\r\n /Notes\r\n \r\n \r\n \r\n \r\n test\r\n /ContactMethod\r\n 6514520366\r\n \r\n"
},
"application/*+xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": "\r\n \r\n \r\n replace\r\n /ContactMethod\r\n 6514520366\r\n \r\n \r\n \r\n add\r\n /CountryCallingCode\r\n 1\r\n \r\n \r\n \r\n remove\r\n /CountryCallingCode\r\n \r\n \r\n \r\n /CountryCallingCode\r\n copy\r\n /Notes\r\n \r\n \r\n \r\n /CountryCallingCode\r\n move\r\n /Notes\r\n \r\n \r\n \r\n \r\n test\r\n /ContactMethod\r\n 6514520366\r\n \r\n"
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Customers/{id}/contactMethods/{contactMethodId}": {
"get": {
"tags": [
"Customer"
],
"summary": "Get Contact Method",
"description": "Gets a contact method for the specified customer.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdContactMethodsByContactMethodIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "contactMethodId",
"in": "path",
"description": "The Id of the contact method",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMethods.EntityContactMethod"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMethods.EntityContactMethod"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMethods.EntityContactMethod"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMethods.EntityContactMethod"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMethods.EntityContactMethod"
}
}
}
}
}
}
},
"/Customers/{id}/contactMethods/summary": {
"get": {
"tags": [
"Customer"
],
"summary": "Get Contact Method Summary",
"description": "Gets the primary contact methods for the customer as well as all of the pinned contact methods and the total number of contact methods.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdContactMethodsSummaryGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.ContactMethods.EntityContactMethod, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.ContactMethods.EntityContactMethod, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.ContactMethods.EntityContactMethod, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.ContactMethods.EntityContactMethod, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.ContactMethods.EntityContactMethod, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.ContactMethods.EntityContactMethod, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.ContactMethods.EntityContactMethod, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Customers/{id}/contactRoles": {
"get": {
"tags": [
"Customer"
],
"summary": "Get Contacts In Roles",
"description": "Gets a list of contacts and their roles for the specified customer ordered by contact name then contact role. Contact Roles can be found in the Contact Roles Datalist.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdContactRolesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of contacts to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of contacts to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerContactsInRolesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerContactsInRolesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerContactsInRolesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerContactsInRolesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerContactsInRolesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerContactsInRolesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerContactsInRolesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Customer"
],
"summary": "Assign Contact Role",
"description": "Assigns an existing customer contact a role for the customer.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdContactRolesPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The employee, role, and other information about how to process the creation request. Valid values for the ConflictResolutionApproach are as follows: \r\n FillInTheGaps = 0, which will only assign the contact the role when no other contact occupies that role already.\r\n AllOrNothing = 1, which will only assign the contact if there are no existing conflicting assigned roles on all entities that would be affected by the update.\r\n OverrideConflicts = 2, which will remove any existing contacts in the specified role on all eligible entities and replace them with the contact specified in the request.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CustomerContactRoleCreateRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CustomerContactRoleCreateRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CustomerContactRoleCreateRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CustomerContactRoleCreateRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CustomerContactRoleCreateRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CustomerContactRoleCreateRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CustomerContactRoleCreateRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CustomerContactRoleCreateRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CreateCustomerContactRoleCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CreateCustomerContactRoleCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CreateCustomerContactRoleCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CreateCustomerContactRoleCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CreateCustomerContactRoleCommand.Result"
}
}
}
}
}
}
},
"/Customers/{id}/contactRoles/{customerContactRoleId}": {
"delete": {
"tags": [
"Customer"
],
"summary": "Remove Contact Role",
"description": "Removes an existing customer contact from a role for the customer.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdContactRolesByCustomerContactRoleIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "customerContactRoleId",
"in": "path",
"description": "The customer contact role Id to remove",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "updateJobOrders",
"in": "query",
"description": "If set to true, the contact will be removed from active job orders associated with the customer. If set to true in conjunction with UpdateDepartments, the contact will be removed from all job orders belonging to the departments as well.",
"required": true,
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "updateDepartments",
"in": "query",
"description": "If set to true, the contact will be removed from active departments associated with the customer.",
"required": true,
"style": "form",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"204": {
"description": "No Content",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.DeleteCustomerContactRoleCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.DeleteCustomerContactRoleCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.DeleteCustomerContactRoleCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.DeleteCustomerContactRoleCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.DeleteCustomerContactRoleCommand.Result"
}
}
}
}
}
}
},
"/Customers/{id}/contactRoles/metadata": {
"get": {
"tags": [
"Customer"
],
"summary": "Check for active assignments based on customer id.",
"description": "Gets the number of inactive departments with active assignments, and the number of\r\ninactive orders with active assignments, for the specified customer.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdContactRolesMetadataGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerRoleCheckActiveAssignments.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerRoleCheckActiveAssignments.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerRoleCheckActiveAssignments.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerRoleCheckActiveAssignments.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerRoleCheckActiveAssignments.Result"
}
}
}
}
}
}
},
"/Customers/{id}/contacts": {
"get": {
"tags": [
"Customer"
],
"summary": "Get Contacts",
"description": "Gets a list of contacts for the specified customer.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdContactsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "isMasterView",
"in": "query",
"description": "Obsolete. Use IncludeContactsOfDepartments. If set to true, contacts for the specified customer and its departments will be returned.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "includeContactsOfDepartments",
"in": "query",
"description": "If set to true, contacts for the specified customer's departments will be included in the results returned.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "includeContactsOfParents",
"in": "query",
"description": "If set to true, contacts for the specified customer's parents will be included in the results returned.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of contacts to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of contacts to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerContactsQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerContactsQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerContactsQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerContactsQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerContactsQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerContactsQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerContactsQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Customers/{id}/creditAndPayroll": {
"get": {
"tags": [
"Customer"
],
"summary": "Get customer credit and payroll details.",
"description": "Gets information about customer credit information and payroll details.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdCreditAndPayrollGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CreditAndPayRoll.CreditAndPayRollSetupQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CreditAndPayRoll.CreditAndPayRollSetupQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CreditAndPayRoll.CreditAndPayRollSetupQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CreditAndPayRoll.CreditAndPayRollSetupQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CreditAndPayRoll.CreditAndPayRollSetupQuery.Result"
}
}
}
}
}
},
"put": {
"tags": [
"Customer"
],
"summary": "Update customer credit and payroll details.",
"description": "Update credit limit info and terms.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdCreditAndPayrollPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The request body containing the new values for the customer credit information and payroll details.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerCreditAndPayRollSetupRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerCreditAndPayRollSetupRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerCreditAndPayRollSetupRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerCreditAndPayRollSetupRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerCreditAndPayRollSetupRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerCreditAndPayRollSetupRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerCreditAndPayRollSetupRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerCreditAndPayRollSetupRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Customers/{id}/CustomData": {
"get": {
"tags": [
"Customer"
],
"summary": "Get Custom Data",
"description": "Gets a list of Custom Data Properties for a Customer.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdCustomDataGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "includeInactiveProperties",
"in": "query",
"description": "When true, any properties that have been marked inactive will also be returned.",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.CustomData.EntityCustomDataQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.CustomData.EntityCustomDataQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.CustomData.EntityCustomDataQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.CustomData.EntityCustomDataQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.CustomData.EntityCustomDataQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.CustomData.EntityCustomDataQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.CustomData.EntityCustomDataQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"put": {
"tags": [
"Customer"
],
"summary": "Update Custom Data",
"description": "Updates the Custom Data Properties for a Customer.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdCustomDataPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The list of values to store.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.CustomData.UpdateEntityCustomDataRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.CustomData.UpdateEntityCustomDataRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.CustomData.UpdateEntityCustomDataRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.CustomData.UpdateEntityCustomDataRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.CustomData.UpdateEntityCustomDataRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.CustomData.UpdateEntityCustomDataRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.CustomData.UpdateEntityCustomDataRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.CustomData.UpdateEntityCustomDataRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Customers/{id}/defaults/accruals": {
"get": {
"tags": [
"Customer"
],
"summary": "Get Accruals",
"description": "Gets a list of accruals for the specified customer.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdDefaultsAccrualsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "ActiveOnly",
"in": "query",
"description": "Limit the results to active only accruals. Defaults to false.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "CustomerAccrualId",
"in": "query",
"description": "Optional value to limit to a specific accrual. If specified, a not found exception will be thrown if the CustomerAccrualId is not valid for the customer.",
"style": "form",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "Skip",
"in": "query",
"description": "Amount of list items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Take",
"in": "query",
"description": "Amount of list items to take. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.Accruals.CustomerAccrualsList.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.Accruals.CustomerAccrualsList.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.Accruals.CustomerAccrualsList.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.Accruals.CustomerAccrualsList.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.Accruals.CustomerAccrualsList.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.Accruals.CustomerAccrualsList.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.Accruals.CustomerAccrualsList.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Customer"
],
"summary": "Create Customer Accrual",
"description": "Creates a new accrual for the specified customer.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdDefaultsAccrualsPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The accrual to create.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerAccrualRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerAccrualRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerAccrualRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerAccrualRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerAccrualRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerAccrualRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerAccrualRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerAccrualRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CreateCustomerAccrual.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CreateCustomerAccrual.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CreateCustomerAccrual.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CreateCustomerAccrual.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CreateCustomerAccrual.Result"
}
}
}
}
}
}
},
"/Customers/{id}/defaults/accruals/{customerAccrualId}": {
"put": {
"tags": [
"Customer"
],
"summary": "Update Customer Accrual",
"description": "Updates an accrual for the specified customer.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdDefaultsAccrualsByCustomerAccrualIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "customerAccrualId",
"in": "path",
"description": "The Id of the customer's accrual.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The accrual to update.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerAccrualRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerAccrualRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerAccrualRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerAccrualRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerAccrualRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerAccrualRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerAccrualRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerAccrualRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
},
"delete": {
"tags": [
"Customer"
],
"summary": "Delete Customer Accrual",
"description": "Deletes a specified customer accrual.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdDefaultsAccrualsByCustomerAccrualIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "customerAccrualId",
"in": "path",
"description": "The Id of the customer accrual.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Customers/{id}/defaults/jobDescription": {
"post": {
"tags": [
"Customer"
],
"summary": "Create customer default job description.",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdDefaultsJobDescriptionPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the customer.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The request body containing the new default job description.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerDefaultJobDescriptionRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerDefaultJobDescriptionRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerDefaultJobDescriptionRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerDefaultJobDescriptionRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerDefaultJobDescriptionRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerDefaultJobDescriptionRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerDefaultJobDescriptionRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerDefaultJobDescriptionRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CreateCustomerDefaultJobDescription.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CreateCustomerDefaultJobDescription.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CreateCustomerDefaultJobDescription.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CreateCustomerDefaultJobDescription.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CreateCustomerDefaultJobDescription.Result"
}
}
}
}
}
}
},
"/Customers/{id}/defaults/jobDescriptions": {
"get": {
"tags": [
"Customer"
],
"summary": "Fetch default job description per customer.",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdDefaultsJobDescriptionsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the customer.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "jobTitleId",
"in": "query",
"description": "The job title id (skill code id).",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "orderBy",
"in": "query",
"description": "The column to order by. The default order is by job title.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "orderByAscending",
"in": "query",
"description": "The order direction.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerDefaultJobDescriptions.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerDefaultJobDescriptions.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerDefaultJobDescriptions.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerDefaultJobDescriptions.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerDefaultJobDescriptions.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerDefaultJobDescriptions.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerDefaultJobDescriptions.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Customers/{id}/defaults/jobDescriptions/{jobDescriptionId}": {
"delete": {
"tags": [
"Customer"
],
"summary": "Deletes a default job description from a customer.",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdDefaultsJobDescriptionsByJobDescriptionIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The customer id.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "jobDescriptionId",
"in": "path",
"description": "The default job description id.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
},
"put": {
"tags": [
"Customer"
],
"summary": "Updates a default job description for a customer.",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdDefaultsJobDescriptionsByJobDescriptionIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The customer id.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "jobDescriptionId",
"in": "path",
"description": "The default job description id.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The job description fields to be updated.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerDefaultJobDescriptionRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerDefaultJobDescriptionRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerDefaultJobDescriptionRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerDefaultJobDescriptionRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerDefaultJobDescriptionRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerDefaultJobDescriptionRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerDefaultJobDescriptionRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerDefaultJobDescriptionRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
},
"get": {
"tags": [
"Customer"
],
"summary": "Gets a default job description.",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdDefaultsJobDescriptionsByJobDescriptionIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The customer id.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "jobDescriptionId",
"in": "path",
"description": "The default job description id.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerDefaultJobDescription.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerDefaultJobDescription.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerDefaultJobDescription.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerDefaultJobDescription.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerDefaultJobDescription.Result"
}
}
}
},
"204": {
"description": "No Content",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerDefaultJobDescription.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerDefaultJobDescription.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerDefaultJobDescription.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerDefaultJobDescription.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerDefaultJobDescription.Result"
}
}
}
}
}
}
},
"/Customers/{id}/defaults/multiplierCodes": {
"get": {
"tags": [
"Customer"
],
"summary": "Get Default Multiplier Codes",
"description": "Returns a list of default multiplier codes ordered by the priority and then the multiplier code.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdDefaultsMultiplierCodesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of multiplier codes to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of multiplier codes to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerDefaultMultiplierCodesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerDefaultMultiplierCodesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerDefaultMultiplierCodesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerDefaultMultiplierCodesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerDefaultMultiplierCodesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerDefaultMultiplierCodesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerDefaultMultiplierCodesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Customer"
],
"summary": "Create Default Multiplier Code",
"description": "Creates a new default multiplier code on the customer.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdDefaultsMultiplierCodesPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The request body containing the new default multiplier code.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerDefaultMultiplierCodeRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerDefaultMultiplierCodeRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerDefaultMultiplierCodeRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerDefaultMultiplierCodeRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerDefaultMultiplierCodeRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerDefaultMultiplierCodeRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerDefaultMultiplierCodeRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerDefaultMultiplierCodeRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CreateCustomerDefaultMultiplierCodeCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CreateCustomerDefaultMultiplierCodeCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CreateCustomerDefaultMultiplierCodeCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CreateCustomerDefaultMultiplierCodeCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CreateCustomerDefaultMultiplierCodeCommand.Result"
}
}
}
}
}
}
},
"/Customers/{id}/defaults/multiplierCodes/{defaultMultiplierCodeId}": {
"put": {
"tags": [
"Customer"
],
"summary": "Update Default Multiplier Code",
"description": "Updates the specified default multiplier code defined on a customer.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdDefaultsMultiplierCodesByDefaultMultiplierCodeIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "defaultMultiplierCodeId",
"in": "path",
"description": "The Id of the default multiplier code.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The request body containing the updated default multiplier code details.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerDefaultMultiplierCodeRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerDefaultMultiplierCodeRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerDefaultMultiplierCodeRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerDefaultMultiplierCodeRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerDefaultMultiplierCodeRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerDefaultMultiplierCodeRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerDefaultMultiplierCodeRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerDefaultMultiplierCodeRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
},
"delete": {
"tags": [
"Customer"
],
"summary": "Delete Default Multiplier Code",
"description": "Deletes the specified default multiplier code from the customer.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdDefaultsMultiplierCodesByDefaultMultiplierCodeIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "defaultMultiplierCodeId",
"in": "path",
"description": "The id of the default multiplier code.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Customers/{id}/defaults/requiredDocumentTypes": {
"get": {
"tags": [
"Customer"
],
"summary": "Get Required Document Types",
"description": "Returns a list of required document types ordered by the required document type name(A-Z).\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdDefaultsRequiredDocumentTypesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of required document types to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of required document types to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerDefaultRequiredDocumentTypes.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerDefaultRequiredDocumentTypes.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerDefaultRequiredDocumentTypes.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerDefaultRequiredDocumentTypes.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerDefaultRequiredDocumentTypes.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerDefaultRequiredDocumentTypes.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerDefaultRequiredDocumentTypes.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Customer"
],
"summary": "Create Customer Default Required Document Type",
"description": "Creates a default required document type for the specified customer.\r\nNot exposing most of the properties here - inserting default values for them in the stored procedure instead.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdDefaultsRequiredDocumentTypesPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The request body containing the required document type id.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerDefaultRequiredDocumentTypeRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerDefaultRequiredDocumentTypeRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerDefaultRequiredDocumentTypeRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerDefaultRequiredDocumentTypeRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerDefaultRequiredDocumentTypeRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerDefaultRequiredDocumentTypeRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerDefaultRequiredDocumentTypeRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerDefaultRequiredDocumentTypeRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CreateCustomerDefaultRequiredDocumentType.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CreateCustomerDefaultRequiredDocumentType.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CreateCustomerDefaultRequiredDocumentType.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CreateCustomerDefaultRequiredDocumentType.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CreateCustomerDefaultRequiredDocumentType.Result"
}
}
}
}
}
}
},
"/Customers/{id}/defaults/requiredDocumentTypes/{customerRequiredDocumentTypeId}": {
"delete": {
"tags": [
"Customer"
],
"summary": "Delete Default Required Document Type",
"description": "Deletes a default required document type associated with the customer.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdDefaultsRequiredDocumentTypesByCustomerRequiredDocumentTypeIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the customer.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "customerRequiredDocumentTypeId",
"in": "path",
"description": "The id of the customer required document type.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
},
"put": {
"tags": [
"Customer"
],
"summary": "Update Default Required Document Type",
"description": "Updates a default required document type associated with the customer.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdDefaultsRequiredDocumentTypesByCustomerRequiredDocumentTypeIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the customer.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "customerRequiredDocumentTypeId",
"in": "path",
"description": "The id of the customer required document type.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The request body containing the updated required document type details.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerDefaultRequiredDocumentTypeRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerDefaultRequiredDocumentTypeRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerDefaultRequiredDocumentTypeRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerDefaultRequiredDocumentTypeRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerDefaultRequiredDocumentTypeRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerDefaultRequiredDocumentTypeRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerDefaultRequiredDocumentTypeRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerDefaultRequiredDocumentTypeRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Customers/{id}/defaults/settings": {
"get": {
"tags": [
"Customer"
],
"summary": "Get Customer Defaults Settings",
"description": "Gets the current settings for the customer defaults. Used to determine how the customer's defaults apply to its departments.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdDefaultsSettingsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerDefaultsSettingsQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerDefaultsSettingsQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerDefaultsSettingsQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerDefaultsSettingsQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerDefaultsSettingsQuery.Result"
}
}
}
}
}
},
"put": {
"tags": [
"Customer"
],
"summary": "Update Customer Defaults Settings",
"description": "Updates how the customer's defaults apply to its departments. Any values that are null are ignored.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdDefaultsSettingsPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The request body containing the updated settings.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerDefaultsSettingsRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerDefaultsSettingsRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerDefaultsSettingsRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerDefaultsSettingsRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerDefaultsSettingsRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerDefaultsSettingsRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerDefaultsSettingsRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerDefaultsSettingsRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Customers/{id}/defaults/shifts": {
"get": {
"tags": [
"Customer"
],
"summary": "Get Default Shifts",
"description": "Returns a list of default shifts ordered by the shift name.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdDefaultsShiftsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of shifts to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of shifts to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerDefaultShiftsQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerDefaultShiftsQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerDefaultShiftsQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerDefaultShiftsQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerDefaultShiftsQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerDefaultShiftsQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerDefaultShiftsQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Customer"
],
"summary": "Create Default Shift",
"description": "Creates a new default shift on the customer.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdDefaultsShiftsPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The request body containing the new shift.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerDefaultShiftRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerDefaultShiftRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerDefaultShiftRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerDefaultShiftRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerDefaultShiftRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerDefaultShiftRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerDefaultShiftRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerDefaultShiftRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CreateCustomerDefaultShiftCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CreateCustomerDefaultShiftCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CreateCustomerDefaultShiftCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CreateCustomerDefaultShiftCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CreateCustomerDefaultShiftCommand.Result"
}
}
}
}
}
}
},
"/Customers/{id}/defaults/shifts/{shiftId}": {
"put": {
"tags": [
"Customer"
],
"summary": "Update Default Shift",
"description": "Updates a default shift defined on a customer.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdDefaultsShiftsByShiftIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "shiftId",
"in": "path",
"description": "The Id of the shift",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The request body containing the updated shift details.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerDefaultShiftRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerDefaultShiftRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerDefaultShiftRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerDefaultShiftRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerDefaultShiftRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerDefaultShiftRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerDefaultShiftRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerDefaultShiftRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
},
"delete": {
"tags": [
"Customer"
],
"summary": "Delete Default Shift",
"description": "Deletes a default shift from the customer. If a shift is referenced in the system it will no longer be visible but will remain in the system for data integrity purposes.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdDefaultsShiftsByShiftIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "shiftId",
"in": "path",
"description": "The id of the shift",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Customers/{id}/defaults/workerCompCodes": {
"get": {
"tags": [
"Customer"
],
"summary": "Get Default Worker Comp Codes",
"description": "Returns a list of default worker comp codes ordered by the priority and then the worker comp code.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdDefaultsWorkerCompCodesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of worker comp codes to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of worker comp codes to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerDefaultWorkerCompCodesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerDefaultWorkerCompCodesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerDefaultWorkerCompCodesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerDefaultWorkerCompCodesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerDefaultWorkerCompCodesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerDefaultWorkerCompCodesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerDefaultWorkerCompCodesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Customer"
],
"summary": "Create Default Worker Comp Code",
"description": "Creates a new default worker comp code on the customer.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdDefaultsWorkerCompCodesPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The request body containing the new default worker comp code.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerDefaultWorkerCompCodeRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerDefaultWorkerCompCodeRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerDefaultWorkerCompCodeRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerDefaultWorkerCompCodeRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerDefaultWorkerCompCodeRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerDefaultWorkerCompCodeRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerDefaultWorkerCompCodeRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerDefaultWorkerCompCodeRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CreateCustomerDefaultWorkerCompCodeCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CreateCustomerDefaultWorkerCompCodeCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CreateCustomerDefaultWorkerCompCodeCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CreateCustomerDefaultWorkerCompCodeCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CreateCustomerDefaultWorkerCompCodeCommand.Result"
}
}
}
}
}
}
},
"/Customers/{id}/defaults/workerCompCodes/{defaultWorkerCompCodeId}": {
"put": {
"tags": [
"Customer"
],
"summary": "Update Default Worker Comp Code",
"description": "Updates a default worker comp code defined on a customer.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdDefaultsWorkerCompCodesByDefaultWorkerCompCodeIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "defaultWorkerCompCodeId",
"in": "path",
"description": "The Id of the default worker comp code.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The request body containing the updated default worker comp code details.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerDefaultWorkerCompCodeRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerDefaultWorkerCompCodeRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerDefaultWorkerCompCodeRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerDefaultWorkerCompCodeRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerDefaultWorkerCompCodeRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerDefaultWorkerCompCodeRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerDefaultWorkerCompCodeRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerDefaultWorkerCompCodeRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
},
"delete": {
"tags": [
"Customer"
],
"summary": "Delete Default Worker Comp Code",
"description": "Deletes a default worker comp code from the customer.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdDefaultsWorkerCompCodesByDefaultWorkerCompCodeIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "defaultWorkerCompCodeId",
"in": "path",
"description": "The id of the default worker comp code.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Customers/{id}/departments": {
"get": {
"tags": [
"Customer"
],
"summary": "Get Departments",
"description": "Returns the departments under the specified customer.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdDepartmentsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "limitToDirectDepartments",
"in": "query",
"description": "If set to true, only direct departments of the current customer will be returned. If set to false, all departments of the current customer will be returned including departments of the customer's departments.",
"required": true,
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "includeInactiveDepartments",
"in": "query",
"description": "If set to false, only active departments will be returned. If set to true, departments will be returned regardless of whether or not they are active.",
"required": true,
"style": "form",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerDepartmentsQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerDepartmentsQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerDepartmentsQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerDepartmentsQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerDepartmentsQuery.Result"
}
}
}
}
}
},
"post": {
"tags": [
"Customer"
],
"summary": "Create Department",
"description": "Creates a department under the customer.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdDepartmentsPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The request body containing information about the new department.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateDepartmentRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateDepartmentRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateDepartmentRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateDepartmentRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateDepartmentRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateDepartmentRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateDepartmentRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateDepartmentRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CreateCustomerDepartmentCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CreateCustomerDepartmentCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CreateCustomerDepartmentCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CreateCustomerDepartmentCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CreateCustomerDepartmentCommand.Result"
}
}
}
}
}
}
},
"/Customers/{id}/documents": {
"get": {
"tags": [
"Customer"
],
"summary": "Get Documents",
"description": "Get a list of documents linked to the customer.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdDocumentsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of documents to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of documents to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "sortByAscending",
"in": "query",
"description": "true to sort by ASC, defaults to DESC",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "sortBy",
"in": "query",
"description": "Field to sort by, valid fields are \"DocumentType\" and \"DocumentDate\"",
"style": "form",
"schema": {
"type": "string",
"default": "DocumentDate"
}
},
{
"name": "filterByDocumentTypeId",
"in": "query",
"description": "DocumentTypeId to filter by",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Documents.GetEntityDocumentsQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Documents.GetEntityDocumentsQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Documents.GetEntityDocumentsQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Documents.GetEntityDocumentsQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Documents.GetEntityDocumentsQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Documents.GetEntityDocumentsQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Documents.GetEntityDocumentsQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Customer"
],
"summary": "Upload Document",
"description": "Uploads a document to the customer. This requires a multipart form-data POST request. \r\nOne part must contain the file to upload and subsequent parts will be used to provide \r\nother data such as documentTypeId.\r\n\r\nFor more information about using formdata, see: https://developer.mozilla.org/en-US/docs/Web/API/FormData/FormData\r\nFor more information about using multimart/form-data, see: http://stackoverflow.com/questions/4526273/what-does-enctype-multipart-form-data-mean\r\nBelow is an example multipart/form-data POST request body:\r\n\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn\r\nContent-Disposition: form-data; name=\"file\"; filename=\"Test.txt\"\r\nContent-Type: text/plain\r\n\r\nThis is where the file content is placed! This is a valid for a text document!\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn\r\nContent-Disposition: form-data; name=\"fileName\"\r\n\r\nNewFileName.txt\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn\r\nContent-Disposition: form-data; name=\"expirationDate\"\r\n\r\n2012-12-21\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn\r\nContent-Disposition: form-data; name=\"documentTypeId\"\r\n\r\n1\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn\r\nContent-Disposition: form-data; name=\"version\"\r\n\r\n1\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn\r\nContent-Disposition: form-data; name=\"description\"\r\n\r\ntest\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn--\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdDocumentsPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"201": {
"description": "Id of the new document",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
}
}
}
}
}
},
"/Customers/{id}/documents/{documentId}": {
"get": {
"tags": [
"Customer"
],
"summary": "Get Document Details",
"description": "Gets details about the specified document from the specified customer.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdDocumentsByDocumentIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "documentId",
"in": "path",
"description": "The Id of the document.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.GetEntityDocumentQuery.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.GetEntityDocumentQuery.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.GetEntityDocumentQuery.Document"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.GetEntityDocumentQuery.Document"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.GetEntityDocumentQuery.Document"
}
}
}
}
}
},
"put": {
"tags": [
"Customer"
],
"summary": "Update Document Details",
"description": "Updates detail information about the document.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdDocumentsByDocumentIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "documentId",
"in": "path",
"description": "The Id of the document.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The body of the request containing the updated details information.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Documents.UpdateEntityDocumentDetailsRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Documents.UpdateEntityDocumentDetailsRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Documents.UpdateEntityDocumentDetailsRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Documents.UpdateEntityDocumentDetailsRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Documents.UpdateEntityDocumentDetailsRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Documents.UpdateEntityDocumentDetailsRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Documents.UpdateEntityDocumentDetailsRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Documents.UpdateEntityDocumentDetailsRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
},
"delete": {
"tags": [
"Customer"
],
"summary": "Delete Document",
"description": "Deletes the specified document.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdDocumentsByDocumentIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "documentId",
"in": "path",
"description": "The Id of the document.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Customers/{id}/documents/{documentId}/bytes": {
"get": {
"tags": [
"Customer"
],
"summary": "Get Document",
"description": "Gets the specified document from the specified customer.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdDocumentsByDocumentIdBytesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "documentId",
"in": "path",
"description": "The Id of the document.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "returnPdf",
"in": "query",
"description": "Used to indicated whether or not a PDF should be returned if the file is convertable to PDF",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "string",
"format": "byte"
}
},
"text/csv": {
"schema": {
"type": "string",
"format": "byte"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"type": "string",
"format": "byte"
}
},
"application/json": {
"schema": {
"type": "string",
"format": "byte"
}
},
"text/json": {
"schema": {
"type": "string",
"format": "byte"
}
},
"application/xml": {
"schema": {
"type": "string",
"format": "byte"
}
},
"text/xml": {
"schema": {
"type": "string",
"format": "byte"
}
}
}
}
}
}
},
"/Customers/{id}/documents/metadata": {
"get": {
"tags": [
"Customer"
],
"summary": "Get Documents Metadata",
"description": "Returns information about document creation restrictions.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdDocumentsMetadataGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.DocumentMetadataQuery.Query"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.DocumentMetadataQuery.Query"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.DocumentMetadataQuery.Query"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.DocumentMetadataQuery.Query"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.DocumentMetadataQuery.Query"
}
}
}
}
}
}
},
"/Customers/{id}/doNotAssigns": {
"get": {
"tags": [
"Customer"
],
"summary": "Get a paged list of customer-employee \"do not assign\" items.",
"description": "Returns all \"do not assign\" restrictions of a customer - restricted by both the customer and by employee.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdDoNotAssignsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The customer id.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "employeeId",
"in": "query",
"description": "The employee id. If the employee is provided the result will be filtered by the employee and the customer.",
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.AssignmentRestrictions.EmployeeCustomerDoNotAssign, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.AssignmentRestrictions.EmployeeCustomerDoNotAssign, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.AssignmentRestrictions.EmployeeCustomerDoNotAssign, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.AssignmentRestrictions.EmployeeCustomerDoNotAssign, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.AssignmentRestrictions.EmployeeCustomerDoNotAssign, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.AssignmentRestrictions.EmployeeCustomerDoNotAssign, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.AssignmentRestrictions.EmployeeCustomerDoNotAssign, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Customer"
],
"summary": "Creates a \"do not assign\" restriction between a customer and an employee.",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdDoNotAssignsPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The customer id. The initiator of the restriction.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The body of the request containing the information required to create a \"do not assign\" restriction.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerDoNotAssignRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerDoNotAssignRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerDoNotAssignRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerDoNotAssignRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerDoNotAssignRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerDoNotAssignRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerDoNotAssignRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerDoNotAssignRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.AssignmentRestrictions.CreateEmployeeCustomerDoNotAssign.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.AssignmentRestrictions.CreateEmployeeCustomerDoNotAssign.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.AssignmentRestrictions.CreateEmployeeCustomerDoNotAssign.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.AssignmentRestrictions.CreateEmployeeCustomerDoNotAssign.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.AssignmentRestrictions.CreateEmployeeCustomerDoNotAssign.Result"
}
}
}
}
}
}
},
"/Customers/{id}/doNotAssigns/{doNotAssignId}": {
"delete": {
"tags": [
"Customer"
],
"summary": "Delete a \"do not assign\" restriction between a customer and an employee.",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdDoNotAssignsByDoNotAssignIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The customer id.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "doNotAssignId",
"in": "path",
"description": "The id of the do not assign request.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Customers/{id}/financials": {
"get": {
"tags": [
"Customer"
],
"summary": "Get Financial Details",
"description": "Gets AR and Sales figures for the specified customer.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdFinancialsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "isMasterView",
"in": "query",
"description": "If set to true, totals for the specified customer and its departments will be returned.",
"style": "form",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerFinancialsQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerFinancialsQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerFinancialsQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerFinancialsQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerFinancialsQuery.Result"
}
}
}
}
}
}
},
"/Customers/{id}/interestCodes": {
"get": {
"tags": [
"Customer"
],
"summary": "Get Customer Interest Codes",
"description": "Returns a paged list of customer interest codes ordered by the InterestCode column.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdInterestCodesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of interest codes to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of interest codes to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.InterestCodes.CustomerInterestCodesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.InterestCodes.CustomerInterestCodesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.InterestCodes.CustomerInterestCodesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.InterestCodes.CustomerInterestCodesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.InterestCodes.CustomerInterestCodesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.InterestCodes.CustomerInterestCodesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.InterestCodes.CustomerInterestCodesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Customer"
],
"summary": "Create Customer Interest Code",
"description": "Creates a customer interest code.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdInterestCodesPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The request body containing the customer interest code to create.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerInterestCodeRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerInterestCodeRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerInterestCodeRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerInterestCodeRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerInterestCodeRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerInterestCodeRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerInterestCodeRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerInterestCodeRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.InterestCodes.CreateCustomerInterestCodeCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.InterestCodes.CreateCustomerInterestCodeCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.InterestCodes.CreateCustomerInterestCodeCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.InterestCodes.CreateCustomerInterestCodeCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.InterestCodes.CreateCustomerInterestCodeCommand.Result"
}
}
}
}
}
},
"put": {
"tags": [
"Customer"
],
"summary": "Update Customer Interest Codes",
"description": "Updates a customer's interest codes.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdInterestCodesPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The request body containing an updated list of the customer's interest codes.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerInterestCodesRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerInterestCodesRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerInterestCodesRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerInterestCodesRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerInterestCodesRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerInterestCodesRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerInterestCodesRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerInterestCodesRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Customers/{id}/interestCodes/{customerInterestCodeId}": {
"get": {
"tags": [
"Customer"
],
"summary": "Get Customer Interest Code",
"description": "Gets a customer interest code.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdInterestCodesByCustomerInterestCodeIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "customerInterestCodeId",
"in": "path",
"description": "The Id of the customer interest code.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.InterestCodes.CustomerInterestCodesQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.InterestCodes.CustomerInterestCodesQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.InterestCodes.CustomerInterestCodesQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.InterestCodes.CustomerInterestCodesQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.InterestCodes.CustomerInterestCodesQuery.Result"
}
}
}
}
}
},
"delete": {
"tags": [
"Customer"
],
"summary": "Delete Customer Interest Code",
"description": "Deletes a customer interest code.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdInterestCodesByCustomerInterestCodeIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "customerInterestCodeId",
"in": "path",
"description": "The Id of the customer interest code to delete.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
},
"put": {
"tags": [
"Customer"
],
"summary": "Update Customer Interest Code",
"description": "Updates a customer interest code. Note that updates on the InterestCodeId will set the date created to today.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdInterestCodesByCustomerInterestCodeIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "customerInterestCodeId",
"in": "path",
"description": "The Id of the customer interest code.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The request body containing the customer interest code to update.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerInterestCodeRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerInterestCodeRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerInterestCodeRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerInterestCodeRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerInterestCodeRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerInterestCodeRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerInterestCodeRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerInterestCodeRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Customers/{id}/invoices": {
"get": {
"tags": [
"Customer"
],
"summary": "Get Invoices",
"description": "Gets a list of invoices for the specified customer.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdInvoicesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "Skip",
"in": "query",
"description": "The number of invoices to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Take",
"in": "query",
"description": "The number of invoices to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "StartingInvoiceDate",
"in": "query",
"description": "An optional parameter. Only invoices with an invoice date greater than or equal to the specified date will be returned.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "EndingInvoiceDate",
"in": "query",
"description": "An optional parameter. Only invoices with an invoice date less than or equal to the specified date will be returned.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "DueDate",
"in": "query",
"description": "An optional parameter. Only invoices with a due date equal to the specified date will be returned.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "InvoiceNumber",
"in": "query",
"description": "An optional parameter. Only invoices with an invoice number starting with the specified invoice number will be returned.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "InvoiceId",
"in": "query",
"description": "An optional parameter. Only the invoice with the specified Id will be returned.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "InvoiceAmount",
"in": "query",
"description": "An optional parameter. Only invoices with an invoice amount equal to the specified amount will be returned.",
"style": "form",
"schema": {
"type": "number",
"format": "double"
}
},
{
"name": "InvoiceBalance",
"in": "query",
"description": "An optional parameter. Only invoices with an invoice balance equal to the specified balance will be returned.",
"style": "form",
"schema": {
"type": "number",
"format": "double"
}
},
{
"name": "BranchId",
"in": "query",
"description": "An optional parameter. Only invoices in the branch with the specified Id will be returned.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "ShowUnpostedInvoices",
"in": "query",
"description": "An optional parameter. If set to true, unposted invoices will be eligible to be returned. If set to false, only posted invoices will be returned.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "ShowOnlyInvoicesOverdueAsOf",
"in": "query",
"description": "An optional parameter. Only invoices with a due date earlier or equal to the specified date with an outstanding balance will be returned.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "HideBalancedInvoices",
"in": "query",
"description": "An optional parameter. If set to true, invoices with a balance of zero will not be returned.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "IncludeInvoicesForChildDepartments",
"in": "query",
"description": "An optional parameter. If set to true, customers with child record invoices will be returned.",
"style": "form",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerInvoiceHistoryQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerInvoiceHistoryQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerInvoiceHistoryQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerInvoiceHistoryQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerInvoiceHistoryQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerInvoiceHistoryQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerInvoiceHistoryQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Customers/{id}/messages": {
"get": {
"tags": [
"Customer"
],
"summary": "Get Messages",
"description": "Gets a list of messages linked to the Customer. Messages created in the departments are also returned if the IsMasterView parameter is true.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdMessagesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "messageActionId",
"in": "query",
"description": "Optional filter on the Id of the message action. Valid values can be found in the Message Action List. ref: /datalists/messageactions",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "messageActionTypeId",
"in": "query",
"description": "Optional filter on the Id of the message action type. Valid values can be found in the Message Action Type List. ref: /datalists/messageactiontypes",
"style": "form",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "authorSrIdent",
"in": "query",
"description": "Optional filter on the Id of the service rep who created the message.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "startDate",
"in": "query",
"description": "Optional filter on the date of the message. Any messages created on or after the date supplied will be returned.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "endDate",
"in": "query",
"description": "Optional filter on the date of the message. Any messages created on or before the date supplied will be returned.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "orderBy",
"in": "query",
"description": "Optional parameter to specify the column to order by. Valid values are 'date', 'action', 'actiondescription','authorsrident','author','id', and 'message', Defaults to 'date'",
"style": "form",
"schema": {
"maxLength": 150,
"minLength": 0,
"type": "string"
}
},
{
"name": "orderByAscending",
"in": "query",
"description": "Optional parameter to specify the direction to order by. Specify true to order ascending. The default value is false.",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "messageText",
"in": "query",
"description": "Optional parameter to search on the message text. Example: To search for any message which contains a word which starts with accep, the value would be accep*",
"style": "form",
"schema": {
"maxLength": 1000,
"minLength": 0,
"type": "string"
}
},
{
"name": "limitToPrimaryMessages",
"in": "query",
"description": "Set to true to only return the primary messages. Currently only one primary message is supported. \r\n This can be set using the endpoint PATCH customers/{id} and setting the value PrimaryMessageId.\r\n Optional filters such as start date and end date are ignored when this value is true.",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "isMasterView",
"in": "query",
"description": "f set to true, messages for the specified customer and its departments will be returned.",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "skip",
"in": "query",
"description": "The number of messages to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of messages to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerContactMessagesQuery.CustomerMessageSummary, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerContactMessagesQuery.CustomerMessageSummary, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerContactMessagesQuery.CustomerMessageSummary, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerContactMessagesQuery.CustomerMessageSummary, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerContactMessagesQuery.CustomerMessageSummary, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerContactMessagesQuery.CustomerMessageSummary, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerContactMessagesQuery.CustomerMessageSummary, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Customer"
],
"summary": "Create Message",
"description": "Creates a message and links it to the customer.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdMessagesPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The body of the request containing the information required to create the message.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateMessageWithLinkedDocumentsRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateMessageWithLinkedDocumentsRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateMessageWithLinkedDocumentsRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateMessageWithLinkedDocumentsRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateMessageWithLinkedDocumentsRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateMessageWithLinkedDocumentsRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateMessageWithLinkedDocumentsRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateMessageWithLinkedDocumentsRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
}
}
}
}
}
},
"/Customers/{id}/messages/{messageId}": {
"get": {
"tags": [
"Customer"
],
"summary": "Gets the details of a specific message",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdMessagesByMessageIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "messageId",
"in": "path",
"description": "The Id of the message.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "isMasterView",
"in": "query",
"description": "if set to true, message for the specified customer and its departments will be returned.",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerContactMessageDetails.CustomerMessageSummary"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerContactMessageDetails.CustomerMessageSummary"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerContactMessageDetails.CustomerMessageSummary"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerContactMessageDetails.CustomerMessageSummary"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerContactMessageDetails.CustomerMessageSummary"
}
}
}
}
}
}
},
"/Customers/{id}/metadata": {
"get": {
"tags": [
"Customer"
],
"summary": "Get Basic Metadata",
"description": "Gets basic metadata about the specified customer and actions that the user can perform with it.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdMetadataGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerDetailsMetadataQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerDetailsMetadataQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerDetailsMetadataQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerDetailsMetadataQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerDetailsMetadataQuery.Result"
}
}
}
}
}
}
},
"/Customers/{id}/multiplierCodes": {
"get": {
"tags": [
"Customer"
],
"summary": "Get Multiplier Codes",
"description": "Returns a list of multiplier codes ordered by the priority specified by the customer defaults and then the multiplier code.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdMultiplierCodesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of multiplier codes to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of multiplier codes to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerMultiplierCodesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerMultiplierCodesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerMultiplierCodesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerMultiplierCodesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerMultiplierCodesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerMultiplierCodesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerMultiplierCodesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Customers/{id}/orderDefaults": {
"get": {
"tags": [
"Customer"
],
"summary": "Get Customer Order Defaults",
"description": "Gets the default order settings for the specified customer.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdOrderDefaultsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerOrderDefaultsQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerOrderDefaultsQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerOrderDefaultsQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerOrderDefaultsQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerOrderDefaultsQuery.Result"
}
}
}
}
}
},
"put": {
"tags": [
"Customer"
],
"summary": "Update Customer Order Defaults",
"description": "Updates Order Defaults for the specified customer.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdOrderDefaultsPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The new values for the customer sales information",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerOrderDefaultsRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerOrderDefaultsRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerOrderDefaultsRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerOrderDefaultsRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerOrderDefaultsRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerOrderDefaultsRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerOrderDefaultsRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerOrderDefaultsRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Customers/{id}/orders": {
"get": {
"tags": [
"Customer"
],
"summary": "Get Job Orders",
"description": "Gets a list of job orders for the specified customer. The job orders are ordered from those with the oldest start date appearing first.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdOrdersGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "isMasterView",
"in": "query",
"description": "If set to true, job orders for the specified customer and its departments will be returned.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of job orders to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of job orders to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "ordersAreFilled",
"in": "query",
"description": "Used to filter on filled/unfilled job orders. Can be left null and no filtering will be performed.",
"style": "form",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerOrdersQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerOrdersQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerOrdersQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerOrdersQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerOrdersQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerOrdersQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerOrdersQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Customers/{id}/parentCustomer": {
"put": {
"tags": [
"Customer"
],
"summary": "Change the parent customer.",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdParentCustomerPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the customer.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The details of the new parent.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.ChangeParentCustomerRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.ChangeParentCustomerRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.ChangeParentCustomerRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.ChangeParentCustomerRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.ChangeParentCustomerRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.ChangeParentCustomerRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.ChangeParentCustomerRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.ChangeParentCustomerRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerParentCustomerMetadata.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerParentCustomerMetadata.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerParentCustomerMetadata.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerParentCustomerMetadata.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerParentCustomerMetadata.Result"
}
}
}
}
}
}
},
"/Customers/{id}/parentCustomer/metadata": {
"get": {
"tags": [
"Customer"
],
"summary": "Gets the customer parent customer metadata.",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdParentCustomerMetadataGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the customer.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerParentCustomerMetadata.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerParentCustomerMetadata.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerParentCustomerMetadata.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerParentCustomerMetadata.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerParentCustomerMetadata.Result"
}
}
}
}
}
}
},
"/Customers/{id}/purchaseOrders": {
"get": {
"tags": [
"Customer"
],
"summary": "Get Purchase Orders",
"description": "Gets a list of purchase orders applicable to the customer.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdPurchaseOrdersGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of purchase orders to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of purchase orders to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "active",
"in": "query",
"description": "An optional parameter to filter active or inactive purchase orders",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "purchaseOrderCustomerId",
"in": "query",
"description": "An optional filter. Only purchase orders with a customer id with the specified value will be returned.",
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "purchaseOrderNumber",
"in": "query",
"description": "An optional filter. Only purchase orders with a purchase order number beginning with the specified value will be returned.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "departmentName",
"in": "query",
"description": "An optional filter. Only purchase orders belonging to a department whose name starts with the specified string will be returned.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "purchaseOrderValue",
"in": "query",
"description": "An optional filter. Only purchase orders with a value equal to the specified value will be returned.",
"style": "form",
"schema": {
"type": "number",
"format": "double"
}
},
{
"name": "purchaseOrderCustomerName",
"in": "query",
"description": "An optional filter. Only purchase orders belonging to a customer whose name starts with the specified string will be returned.",
"style": "form",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.PurchaseOrders.CustomerPurchaseOrdersQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.PurchaseOrders.CustomerPurchaseOrdersQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.PurchaseOrders.CustomerPurchaseOrdersQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.PurchaseOrders.CustomerPurchaseOrdersQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.PurchaseOrders.CustomerPurchaseOrdersQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.PurchaseOrders.CustomerPurchaseOrdersQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.PurchaseOrders.CustomerPurchaseOrdersQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Customer"
],
"summary": "Create Purchase Order",
"description": "Creates a purchase order.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdPurchaseOrdersPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The request body containing information about the new purchase order.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreatePurchaseOrderRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreatePurchaseOrderRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreatePurchaseOrderRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreatePurchaseOrderRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreatePurchaseOrderRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreatePurchaseOrderRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreatePurchaseOrderRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreatePurchaseOrderRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.PurchaseOrders.CreateCustomerPurchaseOrderCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.PurchaseOrders.CreateCustomerPurchaseOrderCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.PurchaseOrders.CreateCustomerPurchaseOrderCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.PurchaseOrders.CreateCustomerPurchaseOrderCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.PurchaseOrders.CreateCustomerPurchaseOrderCommand.Result"
}
}
}
}
}
}
},
"/Customers/{id}/purchaseOrders/{purchaseOrderId}": {
"get": {
"tags": [
"Customer"
],
"summary": "Get Purchase Order Details",
"description": "Gets detailed information about the specified purchase order.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdPurchaseOrdersByPurchaseOrderIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "purchaseOrderId",
"in": "path",
"description": "The Id of the purchase order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.PurchaseOrders.CustomerPurchaseOrderQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.PurchaseOrders.CustomerPurchaseOrderQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.PurchaseOrders.CustomerPurchaseOrderQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.PurchaseOrders.CustomerPurchaseOrderQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.PurchaseOrders.CustomerPurchaseOrderQuery.Result"
}
}
}
}
}
},
"put": {
"tags": [
"Customer"
],
"summary": "Update Purchase Order",
"description": "Updates the specified purchase order.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdPurchaseOrdersByPurchaseOrderIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "purchaseOrderId",
"in": "path",
"description": "The id of the purchase order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The request body containing updated information about the purchase order.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdatePurchaseOrderRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdatePurchaseOrderRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdatePurchaseOrderRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdatePurchaseOrderRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdatePurchaseOrderRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdatePurchaseOrderRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdatePurchaseOrderRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdatePurchaseOrderRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Customers/{id}/purchaseOrders/{purchaseOrderId}/assignToRelatedEntities": {
"put": {
"tags": [
"Customer"
],
"summary": "Assign Purchase Order To Related Entities",
"description": "Assigns the PO to the related active orders, active assignments, and/or unbilled timecards as specified.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdPurchaseOrdersByPurchaseOrderIdAssignToRelatedEntitiesPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "purchaseOrderId",
"in": "path",
"description": "The Id of the purchase order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The request body containing information as to which entities should be updated.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.AssignPurchaseOrderToRelatedEntitiesRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.AssignPurchaseOrderToRelatedEntitiesRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.AssignPurchaseOrderToRelatedEntitiesRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.AssignPurchaseOrderToRelatedEntitiesRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.AssignPurchaseOrderToRelatedEntitiesRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.AssignPurchaseOrderToRelatedEntitiesRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.AssignPurchaseOrderToRelatedEntitiesRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.AssignPurchaseOrderToRelatedEntitiesRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.PurchaseOrders.AssignPurchaseOrderToRelatedEntitiesCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.PurchaseOrders.AssignPurchaseOrderToRelatedEntitiesCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.PurchaseOrders.AssignPurchaseOrderToRelatedEntitiesCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.PurchaseOrders.AssignPurchaseOrderToRelatedEntitiesCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.PurchaseOrders.AssignPurchaseOrderToRelatedEntitiesCommand.Result"
}
}
}
}
}
}
},
"/Customers/{id}/sales": {
"get": {
"tags": [
"Customer"
],
"summary": "Get Customer Sales and Service Details",
"description": "Gets sales information about the specified customer.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdSalesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerSalesInformationQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerSalesInformationQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerSalesInformationQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerSalesInformationQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerSalesInformationQuery.Result"
}
}
}
}
}
},
"put": {
"tags": [
"Customer"
],
"summary": "Update Customer Sales and Service Details",
"description": "Updates sales information about the specified customer.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdSalesPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The new values for the customer sales information",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerSalesRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerSalesRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerSalesRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerSalesRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerSalesRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerSalesRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerSalesRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerSalesRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/Customers/{id}/salesTaxes": {
"get": {
"tags": [
"Customer"
],
"summary": "Get Sales Taxes",
"description": "Gets a list of sales taxes applied to the customer.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdSalesTaxesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "asOfDate",
"in": "query",
"description": "Used to filter out past/expired sales taxes.",
"required": true,
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of sales taxes to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of sales taxes to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TempWorks.TwApi.Common.Models.SalesTax, TempWorks.TwApi.Common.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TempWorks.TwApi.Common.Models.SalesTax, TempWorks.TwApi.Common.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TempWorks.TwApi.Common.Models.SalesTax, TempWorks.TwApi.Common.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TempWorks.TwApi.Common.Models.SalesTax, TempWorks.TwApi.Common.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TempWorks.TwApi.Common.Models.SalesTax, TempWorks.TwApi.Common.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TempWorks.TwApi.Common.Models.SalesTax, TempWorks.TwApi.Common.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TempWorks.TwApi.Common.Models.SalesTax, TempWorks.TwApi.Common.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Customer"
],
"summary": "Create Sales Tax",
"description": "Adds a sales tax to the customer.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdSalesTaxesPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The request body containing the sales tax to add.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerSalesTaxRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerSalesTaxRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerSalesTaxRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerSalesTaxRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerSalesTaxRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerSalesTaxRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerSalesTaxRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerSalesTaxRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created"
}
}
}
},
"/Customers/{id}/salesTaxes/{salesTaxJurisdictionId}": {
"delete": {
"tags": [
"Customer"
],
"summary": "Delete Sales Tax",
"description": "Removes a sales tax from the customer.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdSalesTaxesBySalesTaxJurisdictionIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "salesTaxJurisdictionId",
"in": "path",
"description": "The Id of the sales tax jurisdiction to remove",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Customers/{id}/shifts": {
"get": {
"tags": [
"Customer"
],
"summary": "Get Shifts",
"description": "Returns a list of shifts ordered by the shift name.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdShiftsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of shifts to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of shifts to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerDefaultShiftsQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerDefaultShiftsQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerDefaultShiftsQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerDefaultShiftsQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerDefaultShiftsQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerDefaultShiftsQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerDefaultShiftsQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Customers/{id}/Status": {
"post": {
"tags": [
"Customer"
],
"summary": "Update Customer Status",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdStatusPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The details of the status change.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.StatusChange.StatusChangeApiRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.StatusChange.StatusChangeApiRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.StatusChange.StatusChangeApiRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.StatusChange.StatusChangeApiRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.StatusChange.StatusChangeApiRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.StatusChange.StatusChangeApiRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.StatusChange.StatusChangeApiRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.StatusChange.StatusChangeApiRequest"
}
}
}
},
"responses": {
"200": {
"description": "Status Changed",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerStatusUpdateCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerStatusUpdateCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerStatusUpdateCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerStatusUpdateCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerStatusUpdateCommand.Result"
}
}
}
},
"202": {
"description": "Status Changed and Additional Actions are staged for execution or had errors that require additional attention.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerStatusUpdateCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerStatusUpdateCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerStatusUpdateCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerStatusUpdateCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerStatusUpdateCommand.Result"
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/Customers/{id}/Status/{newCustomerStatusId}/metadata": {
"get": {
"tags": [
"Customer"
],
"summary": "Get Customer Status Change Metadata",
"description": "Returns the Validation regarding the status change for a Customer. \r\n This includes information regarding the additional actions, validation, and the current state of the prerequisites for the status change.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdStatusByNewCustomerStatusIdMetadataGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "newCustomerStatusId",
"in": "path",
"description": "The Id of the new customer status.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
},
{
"name": "returnAllPrerequisites",
"in": "query",
"description": "When true, all dynamic validation results are returned regardless of error or not. \r\n When false, only the prerequisites that have had errors are returned. Defaults to false.",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "returnAllAdditionalActions",
"in": "query",
"description": "When true, both required and optional additional actions are returned. \r\n When false, only additional actions that are optional are returned. Defaults to true.",
"style": "form",
"schema": {
"type": "boolean",
"default": true
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.StatusChange.OriginStatusChangeMetadataQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.StatusChange.OriginStatusChangeMetadataQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.StatusChange.OriginStatusChangeMetadataQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.StatusChange.OriginStatusChangeMetadataQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.StatusChange.OriginStatusChangeMetadataQuery.Result"
}
}
}
}
}
}
},
"/Customers/{id}/summary": {
"get": {
"tags": [
"Customer"
],
"summary": "Get Summary",
"description": "Gets summary information about the specified customer.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdSummaryGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Customers.CustomerSummary.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Customers.CustomerSummary.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Customers.CustomerSummary.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Customers.CustomerSummary.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Customers.CustomerSummary.Result"
}
}
}
}
}
}
},
"/Customers/{id}/tasks": {
"get": {
"tags": [
"Customer"
],
"summary": "Get Customer Tasks",
"description": "Returns the list of tasks linked to the customer and belonging to the current user.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): (customer-read or customer-write) and (task-read or task-write) ````",
"operationId": "CustomersByIdTasksGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "TaskQueryType",
"in": "query",
"required": true,
"style": "form",
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Enums.TaskQueryTypes"
}
},
{
"name": "Skip",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Take",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "StartDueDate",
"in": "query",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "EndDueDate",
"in": "query",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "Priority",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "IncludeNullDueDates",
"in": "query",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "FilterText",
"in": "query",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "AssignedToServiceRepId",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "TeamId",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "CreatedByServiceRepId",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "IsPinned",
"in": "query",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "StartDateArchived",
"in": "query",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "EndDateArchived",
"in": "query",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "OrderBy",
"in": "query",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "OrderByAscending",
"in": "query",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "Tags",
"in": "query",
"style": "form",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Tasks.TaskListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Tasks.TaskListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Tasks.TaskListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Tasks.TaskListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Tasks.TaskListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Tasks.TaskListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Tasks.TaskListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Customer"
],
"summary": "Create Customer Task",
"description": "Creates a task and links it to the customer.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write and task-write ````",
"operationId": "CustomersByIdTasksPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The body of the request containing the information required to create the task.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateEntityTaskRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateEntityTaskRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateEntityTaskRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateEntityTaskRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateEntityTaskRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateEntityTaskRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateEntityTaskRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateEntityTaskRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.CreateTaskCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.CreateTaskCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.CreateTaskCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.CreateTaskCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.CreateTaskCommand.Result"
}
}
}
}
}
}
},
"/Customers/{id}/tasks/{taskId}": {
"get": {
"tags": [
"Customer"
],
"summary": "Get Customer Task Details",
"description": "Gets more detailed information about a task pertaining to the customer.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): (customer-read or customer-write) and (task-read or task-write) ````",
"operationId": "CustomersByIdTasksByTaskIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.TaskDetailsQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.TaskDetailsQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.TaskDetailsQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.TaskDetailsQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.TaskDetailsQuery.Result"
}
}
}
}
}
},
"put": {
"tags": [
"Customer"
],
"summary": "Update Customer Task",
"description": "Updates a task linked to the customer.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write and task-write ````",
"operationId": "CustomersByIdTasksByTaskIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The body of the request containing the updated task details.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.UpdateTaskRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.UpdateTaskRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.UpdateTaskRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.UpdateTaskRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.UpdateTaskRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.UpdateTaskRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.UpdateTaskRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.UpdateTaskRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Customers/{id}/tasks/{taskId}/archive": {
"put": {
"tags": [
"Customer"
],
"summary": "Archive Customer Task",
"description": "Archives the task linked to the customer.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): customer-write and task-write ````",
"operationId": "CustomersByIdTasksByTaskIdArchivePut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Customers/{id}/tasks/{taskId}/assign": {
"put": {
"tags": [
"Customer"
],
"summary": "Assign Customer Task",
"description": "Assigns the task linked to the customer.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): task-write ````",
"operationId": "CustomersByIdTasksByTaskIdAssignPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The body of the request containing the new assignment details for the task.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Customers/{id}/tasks/{taskId}/messages": {
"get": {
"tags": [
"Customer"
],
"summary": "Get Customer Task Messages List",
"description": "Returns the list of messages linked to the task.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): task-read or task-write ````",
"operationId": "CustomersByIdTasksByTaskIdMessagesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Customer"
],
"summary": "Create Customer Task Message",
"description": "Creates a message and links it to the Task as well as any related Entities.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): task-read or task-write ````",
"operationId": "CustomersByIdTasksByTaskIdMessagesPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The body of the message containing the new message details.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
}
}
}
}
}
},
"/Customers/{id}/tasks/{taskId}/messages/{messageId}": {
"get": {
"tags": [
"Customer"
],
"summary": "Get Customer Task Message Details",
"description": "Returns details about the message.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): task-read or task-write ````",
"operationId": "CustomersByIdTasksByTaskIdMessagesByMessageIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "messageId",
"in": "path",
"description": "The Id of the message.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageSummary"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageSummary"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageSummary"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageSummary"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageSummary"
}
}
}
}
}
}
},
"/Customers/{id}/tasks/{taskId}/pin": {
"put": {
"tags": [
"Customer"
],
"summary": "Pin Customer Task",
"description": "Pins the task linked to the customer.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): customer-write and task-write ````",
"operationId": "CustomersByIdTasksByTaskIdPinPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Customers/{id}/tasks/{taskId}/unarchive": {
"put": {
"tags": [
"Customer"
],
"summary": "Unarchive Customer Task",
"description": "Unarchives the task linked to the customer.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): customer-write and task-write ````",
"operationId": "CustomersByIdTasksByTaskIdUnarchivePut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Customers/{id}/tasks/{taskId}/unpin": {
"put": {
"tags": [
"Customer"
],
"summary": "Unpin Customer Task",
"description": "Unpins the task linked to the customer.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): customer-write and task-write ````",
"operationId": "CustomersByIdTasksByTaskIdUnpinPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Customers/{id}/vendors": {
"get": {
"tags": [
"Customer"
],
"summary": "Get Customer Vendors",
"description": "Gets a list of vendors for the specified customer.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdVendorsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "Skip",
"in": "query",
"description": "Amount of list items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Take",
"in": "query",
"description": "Amount of list items to take. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.Vendors.CustomerVendorsList.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.Vendors.CustomerVendorsList.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.Vendors.CustomerVendorsList.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.Vendors.CustomerVendorsList.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.Vendors.CustomerVendorsList.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.Vendors.CustomerVendorsList.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.Vendors.CustomerVendorsList.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Customers/{id}/Vendors": {
"post": {
"tags": [
"Customer"
],
"summary": "Create a customer company (vendor)",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdVendorsPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The company to link to the customer.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CustomerCompanyRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CustomerCompanyRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CustomerCompanyRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CustomerCompanyRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CustomerCompanyRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CustomerCompanyRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CustomerCompanyRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CustomerCompanyRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.Vendors.CreateCustomerCompany.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.Vendors.CreateCustomerCompany.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.Vendors.CreateCustomerCompany.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.Vendors.CreateCustomerCompany.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.Vendors.CreateCustomerCompany.Result"
}
}
}
}
}
}
},
"/Customers/{id}/vendors/{customerVendorCompanyId}": {
"get": {
"tags": [
"Customer"
],
"summary": "Get Customer Vendor Details",
"description": "Gets the customer company details.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdVendorsByCustomerVendorCompanyIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "customerVendorCompanyId",
"in": "path",
"description": "The Id of the customer company link.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.Vendors.CustomerVendorDetails.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.Vendors.CustomerVendorDetails.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.Vendors.CustomerVendorDetails.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.Vendors.CustomerVendorDetails.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.Vendors.CustomerVendorDetails.Result"
}
}
}
}
}
}
},
"/Customers/{id}/Vendors/{customerVendorCompanyId}": {
"put": {
"tags": [
"Customer"
],
"summary": "Updates a customer company (vendor)",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdVendorsByCustomerVendorCompanyIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "customerVendorCompanyId",
"in": "path",
"description": "The Id of the customer company link.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The company to link to the customer.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CustomerCompanyRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CustomerCompanyRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CustomerCompanyRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CustomerCompanyRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CustomerCompanyRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CustomerCompanyRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CustomerCompanyRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CustomerCompanyRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
},
"delete": {
"tags": [
"Customer"
],
"summary": "Deletes a customer company (vendor)",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdVendorsByCustomerVendorCompanyIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "customerVendorCompanyId",
"in": "path",
"description": "The Id of the customer company link.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Customers/{id}/workerCompCodes": {
"get": {
"tags": [
"Customer"
],
"summary": "Get Worker Comp Codes",
"description": "Gets a list of default worker comp codes for the specified customer. If there are no defaults for the customer, gets a list of all worker comp codes visible to current user.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "CustomersByIdWorkerCompCodesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Used to limit results to worker comp codes for specified customerId.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "Number of worker comp codes to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "Number of worker comp codes to take. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerWorkerCompCodesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerWorkerCompCodesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerWorkerCompCodesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerWorkerCompCodesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerWorkerCompCodesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerWorkerCompCodesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerWorkerCompCodesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Customers/{id}/worksites": {
"get": {
"tags": [
"Customer"
],
"summary": "Get Worksites",
"description": "Gets a list of worksites belonging to the specified customer as well as those belonging to its parents and children. The results are ordered by worksite name.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdWorksitesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of worksites to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of worksites to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.Worksite.CustomerWorksitesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.Worksite.CustomerWorksitesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.Worksite.CustomerWorksitesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.Worksite.CustomerWorksitesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.Worksite.CustomerWorksitesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.Worksite.CustomerWorksitesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.Worksite.CustomerWorksitesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Customer"
],
"summary": "Create Worksite",
"description": "Creates a worksite for the specified customer.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdWorksitesPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The request body containing the information about the new worksite.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateWorksiteRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateWorksiteRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateWorksiteRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateWorksiteRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateWorksiteRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateWorksiteRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateWorksiteRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateWorksiteRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.Worksite.CreateWorksiteCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.Worksite.CreateWorksiteCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.Worksite.CreateWorksiteCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.Worksite.CreateWorksiteCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.Worksite.CreateWorksiteCommand.Result"
}
}
}
}
}
}
},
"/Customers/{id}/worksites/{worksiteId}": {
"put": {
"tags": [
"Customer"
],
"summary": "Update Worksite",
"description": "Updates the specified worksite for the specified customer.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdWorksitesByWorksiteIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "worksiteId",
"in": "path",
"description": "The Id of the worksite",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The request body containing the updated information about the worksite.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateWorksiteRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateWorksiteRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateWorksiteRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateWorksiteRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateWorksiteRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateWorksiteRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateWorksiteRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateWorksiteRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
},
"get": {
"tags": [
"Customer"
],
"summary": "Get Worksite Details",
"description": "Gets detailed information about the specified worksite.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdWorksitesByWorksiteIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "worksiteId",
"in": "path",
"description": "The Id of the worksite",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.Worksite.CustomerWorksiteDetailsQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.Worksite.CustomerWorksiteDetailsQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.Worksite.CustomerWorksiteDetailsQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.Worksite.CustomerWorksiteDetailsQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.Worksite.CustomerWorksiteDetailsQuery.Result"
}
}
}
}
}
}
},
"/Customers/{id}/worksites/{worksiteId}/nto": {
"get": {
"tags": [
"Customer"
],
"summary": "Get Worksite Notice to Owner",
"description": "Gets the Notice To Owner set up on the worksite.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdWorksitesByWorksiteIdNtoGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "worksiteId",
"in": "path",
"description": "The Id of the worksite",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.Worksite.CustomerWorksiteNoticeToOwnerQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.Worksite.CustomerWorksiteNoticeToOwnerQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.Worksite.CustomerWorksiteNoticeToOwnerQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.Worksite.CustomerWorksiteNoticeToOwnerQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.Worksite.CustomerWorksiteNoticeToOwnerQuery.Result"
}
}
}
}
}
},
"post": {
"tags": [
"Customer"
],
"summary": "Create Worksite Notice to Owner",
"description": "Create the Notice to Owner on the worksite.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdWorksitesByWorksiteIdNtoPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "worksiteId",
"in": "path",
"description": "The Id of the worksite",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The request body containing the Notice to Owner.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerWorksiteNoticeToOwnerRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerWorksiteNoticeToOwnerRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerWorksiteNoticeToOwnerRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerWorksiteNoticeToOwnerRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerWorksiteNoticeToOwnerRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerWorksiteNoticeToOwnerRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerWorksiteNoticeToOwnerRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateCustomerWorksiteNoticeToOwnerRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.Worksite.CreateCustomerWorksiteNoticeToOwnerCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.Worksite.CreateCustomerWorksiteNoticeToOwnerCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.Worksite.CreateCustomerWorksiteNoticeToOwnerCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.Worksite.CreateCustomerWorksiteNoticeToOwnerCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.Worksite.CreateCustomerWorksiteNoticeToOwnerCommand.Result"
}
}
}
}
}
}
},
"/Customers/{id}/worksites/{worksiteId}/nto/{noticeToOwnerId}": {
"put": {
"tags": [
"Customer"
],
"summary": "Update Worksite Notice to Owner",
"description": "Update the Notice to Owner on the worksite.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdWorksitesByWorksiteIdNtoByNoticeToOwnerIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "worksiteId",
"in": "path",
"description": "The Id of the worksite",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "noticeToOwnerId",
"in": "path",
"description": "The Id of the Notice to Owner",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The request body containing the Notice to Owner.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerWorksiteNoticeToOwnerRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerWorksiteNoticeToOwnerRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerWorksiteNoticeToOwnerRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerWorksiteNoticeToOwnerRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerWorksiteNoticeToOwnerRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerWorksiteNoticeToOwnerRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerWorksiteNoticeToOwnerRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerWorksiteNoticeToOwnerRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Customers/{id}/worksites/{worksiteId}/payrollTax": {
"put": {
"tags": [
"Customer"
],
"summary": "Update Worksite Payroll Tax",
"description": "Update the Payroll Tax on the worksite.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdWorksitesByWorksiteIdPayrollTaxPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "worksiteId",
"in": "path",
"description": "The Id of the worksite",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The request body containing Payroll Tax data.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerWorksitePayrollTaxRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerWorksitePayrollTaxRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerWorksitePayrollTaxRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerWorksitePayrollTaxRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerWorksitePayrollTaxRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerWorksitePayrollTaxRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerWorksitePayrollTaxRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.UpdateCustomerWorksitePayrollTaxRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Customers/{id}/worksites/{worksiteId}/salesTaxes": {
"get": {
"tags": [
"Customer"
],
"summary": "Get Worksite Sales Taxes",
"description": "Gets the list of sales taxes currently set up on the worksite.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdWorksitesByWorksiteIdSalesTaxesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "worksiteId",
"in": "path",
"description": "The Id of the worksite",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of sales taxes to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of sales taxes to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TempWorks.TwApi.Common.Models.SalesTax, TempWorks.TwApi.Common.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TempWorks.TwApi.Common.Models.SalesTax, TempWorks.TwApi.Common.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TempWorks.TwApi.Common.Models.SalesTax, TempWorks.TwApi.Common.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TempWorks.TwApi.Common.Models.SalesTax, TempWorks.TwApi.Common.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TempWorks.TwApi.Common.Models.SalesTax, TempWorks.TwApi.Common.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TempWorks.TwApi.Common.Models.SalesTax, TempWorks.TwApi.Common.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TempWorks.TwApi.Common.Models.SalesTax, TempWorks.TwApi.Common.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Customer"
],
"summary": "Create Worksite Sales Tax",
"description": "Adds a sales tax to be collected to the worksite.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdWorksitesByWorksiteIdSalesTaxesPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "worksiteId",
"in": "path",
"description": "The Id of the worksite",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The request body containing the sales tax to add.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateWorksiteSalesTaxRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateWorksiteSalesTaxRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateWorksiteSalesTaxRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateWorksiteSalesTaxRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateWorksiteSalesTaxRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateWorksiteSalesTaxRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateWorksiteSalesTaxRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Customers.API.Models.CreateWorksiteSalesTaxRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created"
}
}
}
},
"/Customers/{id}/worksites/{worksiteId}/salesTaxes/{salesTaxJurisdictionId}": {
"delete": {
"tags": [
"Customer"
],
"summary": "Delete Worksite Sales Tax",
"description": "Removes a sales tax to be collected from the worksite.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdWorksitesByWorksiteIdSalesTaxesBySalesTaxJurisdictionIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "worksiteId",
"in": "path",
"description": "The Id of the worksite",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "salesTaxJurisdictionId",
"in": "path",
"description": "The Id of the sales tax jurisdiction to remove",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Customers/{id}/worksites/{worksiteId}/timeclock/punchLocations": {
"get": {
"tags": [
"Customer"
],
"summary": "Get Worksite Timeclock Punch Locations",
"description": "Gets a list of punch locations for the specified worksite. These punch locations are valid places for employees to punch in or out\r\nif geofencing is enabled for the customer in Web Center.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdWorksitesByWorksiteIdTimeclockPunchLocationsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "worksiteId",
"in": "path",
"description": "The Id of the worksite",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "filterString",
"in": "query",
"description": "Filters for punch locations with a name or description starting with the provided string.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Timeclock.PunchLocationList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Timeclock.PunchLocationList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Timeclock.PunchLocationList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Timeclock.PunchLocationList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Timeclock.PunchLocationList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Timeclock.PunchLocationList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Timeclock.PunchLocationList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Customer"
],
"summary": "Create Worksite Timeclock Punch Location",
"description": "Creates a Punch Location for the specified Worksite.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdWorksitesByWorksiteIdTimeclockPunchLocationsPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "worksiteId",
"in": "path",
"description": "The Id of the worksite",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The request body containing the information about the new punch location.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Timeclock.CreatePunchLocationRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Timeclock.CreatePunchLocationRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Timeclock.CreatePunchLocationRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Timeclock.CreatePunchLocationRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Timeclock.CreatePunchLocationRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Timeclock.CreatePunchLocationRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Timeclock.CreatePunchLocationRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Timeclock.CreatePunchLocationRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Timeclock.CreateEntityPunchLocation.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Timeclock.CreateEntityPunchLocation.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Timeclock.CreateEntityPunchLocation.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Timeclock.CreateEntityPunchLocation.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Timeclock.CreateEntityPunchLocation.Result"
}
}
}
}
}
}
},
"/Customers/{id}/worksites/{worksiteId}/timeclock/punchLocations/{punchLocationId}": {
"get": {
"tags": [
"Customer"
],
"summary": "Get Worksite Timeclock Punch Location",
"description": "Gets the specified punch location.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdWorksitesByWorksiteIdTimeclockPunchLocationsByPunchLocationIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "worksiteId",
"in": "path",
"description": "The Id of the worksite",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "punchLocationId",
"in": "path",
"description": "The Id of the punch location",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Timeclock.PunchLocationList.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Timeclock.PunchLocationList.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Timeclock.PunchLocationList.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Timeclock.PunchLocationList.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Timeclock.PunchLocationList.Result"
}
}
}
}
}
},
"put": {
"tags": [
"Customer"
],
"summary": "Update Worksite Timeclock Punch Location",
"description": "Updates the specified Punch Location for the Worksite.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-write ````",
"operationId": "CustomersByIdWorksitesByWorksiteIdTimeclockPunchLocationsByPunchLocationIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "worksiteId",
"in": "path",
"description": "The Id of the worksite",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "punchLocationId",
"in": "path",
"description": "The Id of the punch location",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The request body containing the updated information about the punch location.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Timeclock.UpdatePunchLocationRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Timeclock.UpdatePunchLocationRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Timeclock.UpdatePunchLocationRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Timeclock.UpdatePunchLocationRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Timeclock.UpdatePunchLocationRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Timeclock.UpdatePunchLocationRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Timeclock.UpdatePunchLocationRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Timeclock.UpdatePunchLocationRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
},
"delete": {
"tags": [
"Customer"
],
"summary": "Delete Worksite Timeclock Punch Location",
"description": "Deletes the specified Punch Location for the Worksite.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersByIdWorksitesByWorksiteIdTimeclockPunchLocationsByPunchLocationIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the customer",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "worksiteId",
"in": "path",
"description": "The Id of the worksite",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "punchLocationId",
"in": "path",
"description": "The Id of the punch location",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Customers/sales/pipeline": {
"get": {
"tags": [
"Customer"
],
"summary": "Fetches sales pipeline data.",
"description": "This endpoint retrieves sales pipeline information.\r\nIt allows for sorting and pagination of the result set.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "CustomersSalesPipelineGet",
"parameters": [
{
"name": "orderBy",
"in": "query",
"description": "The column name to order the results by. Supported values are:\r\n 'CustomerId', 'CustomerName', 'DepartmentName', 'AccountManagerServiceRepId', 'AccountManager', \r\n 'SalesPipelineStatus', 'SalesPipelineStatusId', 'EstimatedValue', 'EstimatedValueFrequencyId', \r\n 'EstimatedValueFrequency', 'HowHeardOfId', 'HowHeardOf', 'HowHeardOfDetail', 'SalesTeam', \r\n 'FirstMessageDate', 'LastMessageDate', 'PercentComplete', 'SalesContactFirstName', 'SalesContactLastName', \r\n 'SalesTeamId'",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "orderByAscending",
"in": "query",
"description": "Specifies whether the results should be ordered in ascending order. Default is true.",
"style": "form",
"schema": {
"type": "boolean",
"default": true
}
},
{
"name": "skip",
"in": "query",
"description": "The number of contacts to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of contacts to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "customerId",
"in": "query",
"description": "An optional parameter that will restrict the query to only records that match the specified customer Id.",
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "customerName",
"in": "query",
"description": "An optional parameter that should be a substring of the customer's name. The query will return records containing this substring in the customer name.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "customerStatus",
"in": "query",
"description": "An optional parameter that will restrict the query to only records that match the specified customer status.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "salesPipelineStatusId",
"in": "query",
"description": "An optional parameter that will restrict the query to only records that match the specified sales pipeline status Id.",
"style": "form",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "accountManagerServiceRepId",
"in": "query",
"description": "An optional parameter that will restrict the query to only records that match the account manager service rep Id.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "salesTeamId",
"in": "query",
"description": "An optional parameter that will restrict the query to only records that match the sales Team Id.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "estimatedValueFrequencyId",
"in": "query",
"description": "An optional parameter that will restrict the query to only records that match the specified estimated Value Frequency Id",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "salesContactId",
"in": "query",
"description": "An optional parameter that will restrict the query to only records that match the specified sales contact Id.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Returns the sales pipeline data.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerFetchSalesPipeline.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerFetchSalesPipeline.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerFetchSalesPipeline.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerFetchSalesPipeline.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerFetchSalesPipeline.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerFetchSalesPipeline.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerFetchSalesPipeline.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/acaAvailableEmployerPortionAdjustments": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get ACA Adjustments of type Employer Portion which can be used for an Employee Portion adjustment.",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsAcaAvailableEmployerPortionAdjustmentsGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of types to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of types to take. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "adjustmentId",
"in": "query",
"description": "The Employee Portion adjustment Id",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.GetAvailableEmployerPortionAdjustments.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.GetAvailableEmployerPortionAdjustments.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.GetAvailableEmployerPortionAdjustments.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.GetAvailableEmployerPortionAdjustments.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.GetAvailableEmployerPortionAdjustments.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.GetAvailableEmployerPortionAdjustments.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.GetAvailableEmployerPortionAdjustments.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/acaEmployeeAdjustmentTypes": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get ACA Employee Adjustment Types",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsAcaEmployeeAdjustmentTypesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of types to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of types to take. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AcaEmployeeAdjustmentTypeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AcaEmployeeAdjustmentTypeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AcaEmployeeAdjustmentTypeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AcaEmployeeAdjustmentTypeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AcaEmployeeAdjustmentTypeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AcaEmployeeAdjustmentTypeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AcaEmployeeAdjustmentTypeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/acaEmploymentStatuses": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get ACA Employment Statuses",
"description": "Returns a list of ACA Employment Statuses ordered by Employment Status.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsAcaEmploymentStatusesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of statuses to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of statuses to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AcaEmploymentStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AcaEmploymentStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AcaEmploymentStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AcaEmploymentStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AcaEmploymentStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AcaEmploymentStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AcaEmploymentStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/Accruals": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Accruals",
"description": "Returns a list of Accruals ordered by Name.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsAccrualsGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of accruals to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of accruals to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "isActive",
"in": "query",
"description": "Optional parameter to limit the list to only inactive or active accounts. Leave this parameter blank to obtain all values.",
"style": "form",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AccrualList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AccrualList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AccrualList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AccrualList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AccrualList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AccrualList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AccrualList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/accruals/{accrualId}/tiers": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Accrual Tiers",
"description": "Returns a list of Accrual Tiers ordered by Description.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsAccrualsByAccrualIdTiersGet",
"parameters": [
{
"name": "accrualId",
"in": "path",
"description": "The Id of the accrual that the tiers relate to.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of accrual tiers to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of accrual tiers to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AccrualTierDataListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AccrualTierDataListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AccrualTierDataListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AccrualTierDataListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AccrualTierDataListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AccrualTierDataListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AccrualTierDataListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/adjustmentAuthorities": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Adjustment Authorities",
"description": "Returns a list of Authorities paid via adjustments ordered by Authority.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): payroll-read ````",
"operationId": "DataListsAdjustmentAuthoritiesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of authorities to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of authorities to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AdjustmentAuthoritiesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AdjustmentAuthoritiesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AdjustmentAuthoritiesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AdjustmentAuthoritiesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AdjustmentAuthoritiesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AdjustmentAuthoritiesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AdjustmentAuthoritiesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/adjustmentCategories": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Adjustment Categories",
"description": "Returns a list of Adjustment Categories.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsAdjustmentCategoriesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of categories to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of categories to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AdjustmentCategoriesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AdjustmentCategoriesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AdjustmentCategoriesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AdjustmentCategoriesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AdjustmentCategoriesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AdjustmentCategoriesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AdjustmentCategoriesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/adjustmentFrequencies": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Adjustment Frequencies",
"description": "Returns a list of Frequencies by which adjustments may be paid ordered by the sort order column in the database.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsAdjustmentFrequenciesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of frequencies to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of frequencies to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AdjustmentFrequenciesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AdjustmentFrequenciesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AdjustmentFrequenciesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AdjustmentFrequenciesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AdjustmentFrequenciesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AdjustmentFrequenciesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AdjustmentFrequenciesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/adjustmentRuleCaseColumns": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Adjustment Rule Case Columns",
"description": "Returns a list of Adjustment Rule Case Columns ordered by Column Name.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsAdjustmentRuleCaseColumnsGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of columns to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of columns to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AdjustmentRuleCaseRuleColumnsListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AdjustmentRuleCaseRuleColumnsListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AdjustmentRuleCaseRuleColumnsListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AdjustmentRuleCaseRuleColumnsListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AdjustmentRuleCaseRuleColumnsListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AdjustmentRuleCaseRuleColumnsListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AdjustmentRuleCaseRuleColumnsListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/adjustmentRuleCaseConstraintTypes": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Adjustment Rule Case Constraint Types",
"description": "Returns a list of Adjustment Rule Case Constraints Types ordered by Constraint.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsAdjustmentRuleCaseConstraintTypesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of constraints types to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of constraints types to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AdjustmentRuleCaseRuleConstraintTypesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AdjustmentRuleCaseRuleConstraintTypesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AdjustmentRuleCaseRuleConstraintTypesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AdjustmentRuleCaseRuleConstraintTypesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AdjustmentRuleCaseRuleConstraintTypesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AdjustmentRuleCaseRuleConstraintTypesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AdjustmentRuleCaseRuleConstraintTypesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/adjustments": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Adjustments",
"description": "Returns a list of Adjustments ordered by the Adjustment property.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsAdjustmentsGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of adjustments to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of adjustments to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "isTimecardAdjustment",
"in": "query",
"description": "Optional parameter used to filter on whether or not an adjustment is a timecard adjustment.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "isRecurringAdjustment",
"in": "query",
"description": "Optional parameter used to filter on whether or not an adjustment is a recurring adjustment.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "isActive",
"in": "query",
"description": "Optional parameter used to filter on whether or not an adjustment is active.",
"style": "form",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.AdjustmentsListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.AdjustmentsListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.AdjustmentsListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.AdjustmentsListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.AdjustmentsListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.AdjustmentsListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.AdjustmentsListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/adjustments/{adjustmentId}/defaultRuleCases": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Adjustment Default Rule Cases",
"description": "Returns a list of Default Rule Cases for the specified adjustment. Use this list of Rule Cases when creating an Employee Adjustment.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsAdjustmentsByAdjustmentIdDefaultRuleCasesGet",
"parameters": [
{
"name": "adjustmentId",
"in": "path",
"description": "The Id of the adjustment.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.AdjustmentDefaultRuleCasesQuery.Result"
}
}
},
"text/csv": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.AdjustmentDefaultRuleCasesQuery.Result"
}
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.AdjustmentDefaultRuleCasesQuery.Result"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.AdjustmentDefaultRuleCasesQuery.Result"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.AdjustmentDefaultRuleCasesQuery.Result"
}
}
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.AdjustmentDefaultRuleCasesQuery.Result"
}
}
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.AdjustmentDefaultRuleCasesQuery.Result"
}
}
}
}
}
}
}
},
"/DataLists/adp/locations": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get ADP Locations",
"description": "returns a list of adp organization locations using the ADP Api\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): payroll-write ````",
"operationId": "DataListsAdpLocationsGet",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.Adp.Service.Commands.ADPOrganizationLocationListQuery.Location"
}
}
},
"text/csv": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.Adp.Service.Commands.ADPOrganizationLocationListQuery.Location"
}
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.Adp.Service.Commands.ADPOrganizationLocationListQuery.Location"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.Adp.Service.Commands.ADPOrganizationLocationListQuery.Location"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.Adp.Service.Commands.ADPOrganizationLocationListQuery.Location"
}
}
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.Adp.Service.Commands.ADPOrganizationLocationListQuery.Location"
}
}
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.Adp.Service.Commands.ADPOrganizationLocationListQuery.Location"
}
}
}
}
}
}
}
},
"/DataLists/adp/locations/{locationId}/fundingAccounts": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get ADP Funding Accounts",
"description": "Returns all of the available funding accounts for the specified location. These are used during paycard enrollment and funding.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): payroll-write ````",
"operationId": "DataListsAdpLocationsByLocationIdFundingAccountsGet",
"parameters": [
{
"name": "locationId",
"in": "path",
"description": "The location Id. See datalists/adp/locations for a list of valid values.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.Adp.Service.Commands.ADPPaycardFundingAccountsListQuery.FundingAccount"
}
}
},
"text/csv": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.Adp.Service.Commands.ADPPaycardFundingAccountsListQuery.FundingAccount"
}
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.Adp.Service.Commands.ADPPaycardFundingAccountsListQuery.FundingAccount"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.Adp.Service.Commands.ADPPaycardFundingAccountsListQuery.FundingAccount"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.Adp.Service.Commands.ADPPaycardFundingAccountsListQuery.FundingAccount"
}
}
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.Adp.Service.Commands.ADPPaycardFundingAccountsListQuery.FundingAccount"
}
}
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.Adp.Service.Commands.ADPPaycardFundingAccountsListQuery.FundingAccount"
}
}
}
}
}
}
}
},
"/DataLists/AssessmentLocales": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Assessment Locales",
"description": "Get a paged list of assessment locales ordered by the locale name.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsAssessmentLocalesGet",
"parameters": [
{
"name": "assessmentVendorId",
"in": "query",
"description": "Optional filter to only return locales for the defined assessment vendor. Ref: datalists/assessmentVendors.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.LocalesQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.LocalesQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.LocalesQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.LocalesQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.LocalesQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.LocalesQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.LocalesQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/AssessmentOrgs": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Organizations",
"description": "Get a paged list of assessment organizations ordered by the organization name.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsAssessmentOrgsGet",
"parameters": [
{
"name": "useOrgUnitId",
"in": "query",
"description": "Whether to use the orgUnitId for the list request or not.",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.AssessmentOrgsQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.AssessmentOrgsQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.AssessmentOrgsQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.AssessmentOrgsQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.AssessmentOrgsQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.AssessmentOrgsQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.AssessmentOrgsQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/AssessmentPackages": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Assessment Packages",
"description": "Get a paged list of assessment packages ordered by the package name.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsAssessmentPackagesGet",
"parameters": [
{
"name": "assessmentVendorId",
"in": "query",
"description": "Optional filter to only return packages for the defined assessment vendor. Ref: datalists/assessmentVendors.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "locale",
"in": "query",
"description": "Optional filter to return the list of assessments in the defined locale. Leave null to return the default configured locale. Ref: datalists/assessmentlocales",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.AssessmentPackagesQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.AssessmentPackagesQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.AssessmentPackagesQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.AssessmentPackagesQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.AssessmentPackagesQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.AssessmentPackagesQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.AssessmentPackagesQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/Assessments": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Assessments",
"description": "Get paged list of assessments ordered by the assessment name. Note that the Assessment Id may not be unique since vendors may share the same id. The Tempworks vendor Id of 0 is used for user defined packages.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsAssessmentsGet",
"parameters": [
{
"name": "packageId",
"in": "query",
"description": "Optional filter to only return assessments that exist in a defined package. When using this parameter the assessment vendorId will be required.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "assessmentVendorId",
"in": "query",
"description": "Optional filter to only return assessments for the defined assessment vendor. This value is required when the packageId parameter is defined. Ref: datalists/assessmentVendors",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "locale",
"in": "query",
"description": "Optional filter to return the list of assessments in the defined locale. Ref: datalists/assessmentlocales",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.AssessmentsQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.AssessmentsQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.AssessmentsQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.AssessmentsQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.AssessmentsQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.AssessmentsQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.AssessmentsQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/AssessmentVendors": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Assessment Vendors",
"description": "Get paged list of assessment vendors ordered by the vendor name. Only vendors that are licensed for use will be returned. \r\n The VendorId of 0 (TempWorks) is currently used to denote the User Defined Assessment Packages. Thus it is only valid on the Packages.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsAssessmentVendorsGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.AssessmentVendorsQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.AssessmentVendorsQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.AssessmentVendorsQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.AssessmentVendorsQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.AssessmentVendorsQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.AssessmentVendorsQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.AssessmentVendorsQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/assignmentStatuses": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Assignment Statuses",
"description": "Returns a list of Assignment Statuses ordered by Assignment Status.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsAssignmentStatusesGet",
"parameters": [
{
"name": "isActive",
"in": "query",
"description": "An optional parameter. If not provided or provided no value, all statuses will be returned. If set to true,\r\nonly active statuses will be returned. If set to false, only inactive statuses will be returned.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AssignmentStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AssignmentStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AssignmentStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AssignmentStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AssignmentStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AssignmentStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AssignmentStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/backgroundCheckStatuses": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Background Check Status List",
"description": "Returns a list of background check status types.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): backgroundcheck-read or backgroundcheck-write ````",
"operationId": "DataListsBackgroundCheckStatusesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to take. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.BackgroundCheckStatusTypesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.BackgroundCheckStatusTypesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.BackgroundCheckStatusTypesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.BackgroundCheckStatusTypesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.BackgroundCheckStatusTypesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.BackgroundCheckStatusTypesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.BackgroundCheckStatusTypesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/bankAccounts": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Bank Accounts",
"description": "Returns a list of Bank Accounts ordered by Bank Name. Note that this is a list of the employer's bank accounts, not employees' bank accounts.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsBankAccountsGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of bank accounts to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of bank accounts to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "isActive",
"in": "query",
"description": "Optional parameter to limit the list to only inactive or active accounts. Leave this parameter blank to obtain all values.",
"style": "form",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.BankAccountListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.BankAccountListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.BankAccountListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.BankAccountListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.BankAccountListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.BankAccountListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.BankAccountListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/BatchJobItemStatuses": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Batch Job Item Statuses",
"description": "Returns a list of Batch Job Item Statuses indicating where a Batch Job Item is in the process of being\r\nprocessed.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsBatchJobItemStatusesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.BatchJobItemStatusList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.BatchJobItemStatusList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.BatchJobItemStatusList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.BatchJobItemStatusList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.BatchJobItemStatusList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.BatchJobItemStatusList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.BatchJobItemStatusList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/billingFrequencies": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Billing Frequencies",
"description": "Returns a list of Billing Frequencies ordered by Billing Frequency.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsBillingFrequenciesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of frequencies to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of frequencies to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.BillingFrequencyListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.BillingFrequencyListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.BillingFrequencyListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.BillingFrequencyListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.BillingFrequencyListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.BillingFrequencyListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.BillingFrequencyListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/BiometricsImageAngles": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Image Angles for Biometric Facial Verification",
"description": "Returns a list of image angles used to upload images for facial verification onboarding.\n \n```` Allows roles: ServiceRep, Service, WebUserEmployee ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsBiometricsImageAnglesGet",
"parameters": [
{
"name": "isActive",
"in": "query",
"description": "An optional parameter. If not provided or provided no value, all statuses will be returned. If set to true,\r\nonly active statuses will be returned. If set to false, only inactive statuses will be returned.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "isRequired",
"in": "query",
"description": "An optional parameter. If not provided or provided no value, all statuses will be returned. If set to true,\r\nonly active statuses will be returned. If set to false, only inactive statuses will be returned.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.BiometricsImageAngleListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.BiometricsImageAngleListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.BiometricsImageAngleListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.BiometricsImageAngleListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.BiometricsImageAngleListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.BiometricsImageAngleListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.BiometricsImageAngleListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/branches": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Branches",
"description": "Returns a list of Branches ordered by Branch Name.\n \n```` Allows roles: Service, ServiceRep, WebUserEmployee ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsBranchesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of branches to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of branches to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "active",
"in": "query",
"description": "Optional parameter to limit list to only inactive or active branches. Do not specify to obtain all branches.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "restrictToWebPublicBranches",
"in": "query",
"description": "Optional parameter to limit list to only web public or both public and private branches. If not specified, this will default to false and all branches will be returned.",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "employerId",
"in": "query",
"description": "Optional parameter to limit the list to only branches belonging to the specified employer. A list of employers can be found in the Employers Datalist.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.BranchListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.BranchListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.BranchListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.BranchListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.BranchListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.BranchListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.BranchListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/burdenTypes": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Burden Types",
"description": "Returns a list of Burden Types ordered by Burden Type.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsBurdenTypesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of burden types to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of burden types to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.BurdenTypeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.BurdenTypeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.BurdenTypeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.BurdenTypeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.BurdenTypeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.BurdenTypeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.BurdenTypeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/businessCodes": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Business Codes",
"description": "Returns a list of Business Codes ordered by Code Name.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsBusinessCodesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of business codes to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of business codes to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "active",
"in": "query",
"description": "Optional parameter to limit list to only inactive or active business codes. Do not specify to obtain all business codes.",
"style": "form",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.BusinessCodeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.BusinessCodeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.BusinessCodeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.BusinessCodeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.BusinessCodeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.BusinessCodeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.BusinessCodeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/colorCombos": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Color Combos",
"description": "Returns a list of Color Combos.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsColorCombosGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ColorComboList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ColorComboList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ColorComboList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ColorComboList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ColorComboList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ColorComboList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ColorComboList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/commissionCreditTypes": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Commission Credit Types",
"description": "Returns a list of Commission Credit Types ordered by Credit Type Name\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsCommissionCreditTypesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of records to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to take. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CommissionCreditTypeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CommissionCreditTypeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CommissionCreditTypeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CommissionCreditTypeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CommissionCreditTypeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CommissionCreditTypeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CommissionCreditTypeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/companies": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Companies",
"description": "Returns a list of Companies visible to the current user.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsCompaniesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of companies to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of companies to take. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "name",
"in": "query",
"description": "Optional parameter to limit list to only companies with the given company name or alternate identifier. Will return all companies if not specified.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "active",
"in": "query",
"description": "Optional parameter to limit list to only active or inactive companies. Will return all companies if not specified.",
"style": "form",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.CompanyListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.CompanyListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.CompanyListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.CompanyListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.CompanyListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.CompanyListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.CompanyListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/contactmethodtypes": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Contact Method Types",
"description": "Returns a list of Contact Method Types ordered by Description. Able to filter types to specific origin types of employee, customer and contact.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsContactmethodtypesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of contact method types to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of contact method types to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "originTypeId",
"in": "query",
"description": "Optional parameter to limit the list to contact method types relevant to a specific origin type. Supported origin types are 1 (Employee), 2 (Customer), 3 (Contact).",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ContactMethodTypeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ContactMethodTypeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ContactMethodTypeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ContactMethodTypeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ContactMethodTypeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ContactMethodTypeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ContactMethodTypeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/contactRoles": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Contact Roles",
"description": "Returns a list of Contact Roles ordered by Contact Role.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsContactRolesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of contact roles to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of contact roles to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ContactRoleListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ContactRoleListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ContactRoleListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ContactRoleListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ContactRoleListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ContactRoleListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ContactRoleListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/contactStatuses": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Contact Statuses",
"description": "Returns a list of Contact Statuses.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsContactStatusesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "number of statuses to skip. Used for paging",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "number of statuses to take. Used for paging",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "active",
"in": "query",
"description": "Optional parameter to limit results to only active or inactive statuses.",
"style": "form",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ContactStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ContactStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ContactStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ContactStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ContactStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ContactStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ContactStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/countries": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Countries",
"description": "Returns a list of Countries available in the system ordered by Country.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsCountriesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of countries to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of countries to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.CountryListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.CountryListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.CountryListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.CountryListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.CountryListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.CountryListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.CountryListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/countryCallingCodes": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Country Calling Codes",
"description": "Returns a list of Calling Codes. Only gets codes from countries where the calling code is not null.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsCountryCallingCodesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "Number of calling codes to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "Number of calling codes to take. Used for paging",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.CountryCallingCodeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.CountryCallingCodeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.CountryCallingCodeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.CountryCallingCodeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.CountryCallingCodeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.CountryCallingCodeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.CountryCallingCodeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/countyIncomeTaxJurisdictions": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get County Income Tax Jurisdictions",
"description": "Returns a list of County Income Tax Jurisdictions ordered by County.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsCountyIncomeTaxJurisdictionsGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of jurisdictions to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of jurisdictions to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "taxRegion",
"in": "query",
"description": "Used to restrict the list of jurisdictions to those levied within the specified tax region. A list of Regions can be found in the Regions Datalist.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "filter",
"in": "query",
"description": "An optional parameter used to filter the results. Only Jurisdictions whose County or Jurisdiction contain the specified string will be returned.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "taxJurisdictionId",
"in": "query",
"description": "An optional parameter used to filter the results. If provided the Tax Jurisdiction Id of a result must exactly match this parameter in order to be returned.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.CountyTaxJurisdictionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.CountyTaxJurisdictionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.CountyTaxJurisdictionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.CountyTaxJurisdictionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.CountyTaxJurisdictionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.CountyTaxJurisdictionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.CountyTaxJurisdictionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/creditHoldCodes": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Credit Hold Codes",
"description": "Returns a list of Credit Hold Codes ordered by code.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsCreditHoldCodesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of codes to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of codes to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CreditHoldCodeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CreditHoldCodeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CreditHoldCodeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CreditHoldCodeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CreditHoldCodeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CreditHoldCodeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CreditHoldCodeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/currencies": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get currency list",
"description": "Returns a list of Currencies ordered by Id.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsCurrenciesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of currencies to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of currencies to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CurrenciesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CurrenciesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CurrenciesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CurrenciesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CurrenciesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CurrenciesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CurrenciesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/CustomData/{originTypeId}/Properties": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Datalist for Custom Data Properties",
"description": "Returns list of names of the property.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsCustomDataByOriginTypeIdPropertiesGet",
"parameters": [
{
"name": "originTypeId",
"in": "path",
"description": "Type of the origin",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "propertyType",
"in": "query",
"description": "The type of the property.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "skip",
"in": "query",
"description": "Number of items to skip. Used for paging",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "Number items to take. Used for paging",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.CustomData.GetPropertyDefinitions.Response, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.CustomData.GetPropertyDefinitions.Response, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.CustomData.GetPropertyDefinitions.Response, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.CustomData.GetPropertyDefinitions.Response, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.CustomData.GetPropertyDefinitions.Response, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.CustomData.GetPropertyDefinitions.Response, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.CustomData.GetPropertyDefinitions.Response, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/CustomData/OriginTypes": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Custom Data Origin Types",
"description": "Returns list of origin types available for custom data properties.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsCustomDataOriginTypesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "Number of items to skip. Used for paging",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "Number items to take. Used for paging",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CustomDataSupportedOriginTypesQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CustomDataSupportedOriginTypesQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CustomDataSupportedOriginTypesQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CustomDataSupportedOriginTypesQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CustomDataSupportedOriginTypesQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CustomDataSupportedOriginTypesQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CustomDataSupportedOriginTypesQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/CustomData/PropertyDefinitions/{id}": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Datalist for Custom Data Property Definition",
"description": "Returns list of Values for the defined Property Definition Id.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsCustomDataPropertyDefinitionsByIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the Property Definition.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"description": "Number of items to skip. Used for paging",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "Number items to take. Used for paging",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.CustomDataDatalistQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.CustomDataDatalistQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.CustomDataDatalistQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.CustomDataDatalistQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.CustomDataDatalistQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.CustomDataDatalistQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.CustomDataDatalistQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/CustomData/PropertyTypes": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Custom Data Property Types",
"description": "Returns list of Property Types available for custom data property definitions.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsCustomDataPropertyTypesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "Number of items to skip. Used for paging",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "Number items to take. Used for paging",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CustomDataPropertyTypeQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CustomDataPropertyTypeQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CustomDataPropertyTypeQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CustomDataPropertyTypeQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CustomDataPropertyTypeQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CustomDataPropertyTypeQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CustomDataPropertyTypeQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/customerStatuses": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Customer Statuses",
"description": "Returns a list of Customer Statuses ordered by Status.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsCustomerStatusesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "Number of customer statuses to skip. Used for paging",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "Number of customer statuses to take. Used for paging",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "active",
"in": "query",
"description": "Optional parameter to limit list to only inactive or active statuses. Not specifying will return all statuses.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "limitedToServiceRep",
"in": "query",
"description": "Optional parameter to limit list to only allowed statuses by the service rep's security group. Not specifying will return all statuses.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "impliesProspect",
"in": "query",
"description": "Optional parameter to limit list to only implies prospect statuses.",
"style": "form",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.CustomerStatusListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.CustomerStatusListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.CustomerStatusListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.CustomerStatusListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.CustomerStatusListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.CustomerStatusListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.CustomerStatusListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/customerTypes": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Customer Types",
"description": "Returns a list of Customer Types ordered by type.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsCustomerTypesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of types to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of types to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CustomerTypeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CustomerTypeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CustomerTypeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CustomerTypeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CustomerTypeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CustomerTypeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CustomerTypeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/dateFormats": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Date Formats",
"description": "Returns a list of Date Formats ordered by DateFormatId.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsDateFormatsGet",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.DateFormatListQuery.Result"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.DateFormatListQuery.Result"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.DateFormatListQuery.Result"
}
}
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.DateFormatListQuery.Result"
}
}
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.DateFormatListQuery.Result"
}
}
}
}
}
}
}
},
"/DataLists/distanceUnits": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Distance Units",
"description": "Returns a list of Distance Units ordered by DistanceUnit.\n \n```` Allows roles: ServiceRep, WebUserEmployee, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsDistanceUnitsGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "Number of items to skip. Used for paging",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "Number of items to take. Used for paging",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.DistanceUnitList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.DistanceUnitList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.DistanceUnitList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.DistanceUnitList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.DistanceUnitList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.DistanceUnitList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.DistanceUnitList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/divisions": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Divisions",
"description": "Returns a list of all Divisions.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsDivisionsGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "Number of divisions to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "Number of divisions to take. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.DivisionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.DivisionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.DivisionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.DivisionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.DivisionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.DivisionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.DivisionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/documentTypes": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Document Types",
"description": "Returns a list of Document Types ordered by Document Type.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsDocumentTypesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of document types to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of document types to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.GetDocumentTypesQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.GetDocumentTypesQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.GetDocumentTypesQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.GetDocumentTypesQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.GetDocumentTypesQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.GetDocumentTypesQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.GetDocumentTypesQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/eeoclasses": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get EEO Classes",
"description": "Returns a list of all EEO Classes.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsEeoclassesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "Number of EEO Classes to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "Number of EEO Classes to take. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.EEOClassListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.EEOClassListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.EEOClassListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.EEOClassListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.EEOClassListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.EEOClassListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.EEOClassListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/electronicPayAccountTypes": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Electronic Pay Account Types",
"description": "Returns a list of Electronic Pay Account Types ordered by Account Type.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): payroll-read ````",
"operationId": "DataListsElectronicPayAccountTypesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of account types to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of account types to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ElectronicPayAccountTypesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ElectronicPayAccountTypesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ElectronicPayAccountTypesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ElectronicPayAccountTypesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ElectronicPayAccountTypesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ElectronicPayAccountTypesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ElectronicPayAccountTypesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/electronicPayBankTypes": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Electronic Pay Bank Types",
"description": "Returns a list of Electronic Pay Bank Types ordered by Electronic Pay Bank Type.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): payroll-read ````",
"operationId": "DataListsElectronicPayBankTypesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of bank types to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of bank types to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "isActive",
"in": "query",
"description": "Optional parameter to limit the list to only inactive or active types. Leave this parameter blank to obtain all values.",
"style": "form",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ElectronicPayBankTypesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ElectronicPayBankTypesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ElectronicPayBankTypesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ElectronicPayBankTypesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ElectronicPayBankTypesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ElectronicPayBankTypesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ElectronicPayBankTypesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/emailAccounts": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Email Accounts",
"description": "Returns a list of email accounts setup for this user or shared with this user through ServiceRep Teams.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): email-read ````",
"operationId": "DataListsEmailAccountsGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "Number of accounts to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "Number of accounts to take. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.EmailAccountsList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.EmailAccountsList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.EmailAccountsList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.EmailAccountsList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.EmailAccountsList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.EmailAccountsList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.EmailAccountsList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/emailServiceTypes": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Email Service Types",
"description": "Returns a list of Email Service Types.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): email-read ````",
"operationId": "DataListsEmailServiceTypesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "Number of Service Types to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "Number of Service Types to take. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.EmailServiceTypesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.EmailServiceTypesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.EmailServiceTypesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.EmailServiceTypesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.EmailServiceTypesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.EmailServiceTypesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.EmailServiceTypesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/emailSignatures": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Email Signatures",
"description": "Returns a list of Email Signatures belonging to this user or accessible to this user.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): email-read ````",
"operationId": "DataListsEmailSignaturesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "Number of signatures to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "Number of signatures to take. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.EmailSignaturesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.EmailSignaturesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.EmailSignaturesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.EmailSignaturesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.EmailSignaturesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.EmailSignaturesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.EmailSignaturesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/employeestatuses": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Employee Statuses",
"description": "Returns a list of Employee Statuses ordered by Status.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsEmployeestatusesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of statuses to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of statuses to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "active",
"in": "query",
"description": "Optional parameter to limit list to only inactive or active statuses. Do not specify to obtain all statuses.",
"style": "form",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.EmployeeStatusListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.EmployeeStatusListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.EmployeeStatusListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.EmployeeStatusListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.EmployeeStatusListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.EmployeeStatusListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.EmployeeStatusListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/employers": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Employers",
"description": "Returns a list of Employers visible to the current user.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsEmployersGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of employers to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of employers to take. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "isActive",
"in": "query",
"description": "Optional parameter to limit list to only active or inactive employers.",
"style": "form",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.EmployerListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.EmployerListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.EmployerListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.EmployerListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.EmployerListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.EmployerListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.EmployerListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/employmentcategories": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Employment Categories",
"description": "Returns a list of Employment Categories ordered by Category.\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsEmploymentcategoriesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of categories to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of categories to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "active",
"in": "query",
"description": "Optional parameter to limit list to only inactive or active categories. Do not specify to obtain all categories.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "culture",
"in": "query",
"description": "Optional parameter to pull locale specific interest codes. If a translation\r\n does not exist, then the system will fallback to the system default locale. Do not specify to only\r\n obtain the system default translations for each interest code.",
"style": "form",
"schema": {
"maxLength": 20,
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.EmploymentCategoryListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.EmploymentCategoryListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.EmploymentCategoryListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.EmploymentCategoryListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.EmploymentCategoryListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.EmploymentCategoryListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.EmploymentCategoryListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/externalServiceEncryptionTypes": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get External Service Encryption Types",
"description": "Returns a list of Encryption Types available for use with External Services.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsExternalServiceEncryptionTypesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ExternalServiceEncryptionTypeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ExternalServiceEncryptionTypeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ExternalServiceEncryptionTypeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ExternalServiceEncryptionTypeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ExternalServiceEncryptionTypeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ExternalServiceEncryptionTypeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ExternalServiceEncryptionTypeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/externalServices": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get External Services",
"description": "Returns a list of External Services available for use in the system.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsExternalServicesGet",
"parameters": [
{
"name": "includeInactive",
"in": "query",
"description": "Whether or not to include inactive external services",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ExternalServicesListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ExternalServicesListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ExternalServicesListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ExternalServicesListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ExternalServicesListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ExternalServicesListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ExternalServicesListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/externalServiceVisibilityMethods": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get External Service Visibility Methods",
"description": "Returns a list of Visibility Methods used by External Services to control which part of the system has access to the External Service Credentials.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsExternalServiceVisibilityMethodsGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ExternalServiceVisibilityMethodsListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ExternalServiceVisibilityMethodsListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ExternalServiceVisibilityMethodsListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ExternalServiceVisibilityMethodsListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ExternalServiceVisibilityMethodsListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ExternalServiceVisibilityMethodsListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ExternalServiceVisibilityMethodsListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/frequencies": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Frequencies",
"description": "Returns a list of Frequencies ordered by Name.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsFrequenciesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of frequencies to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of frequencies to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.FrequencyListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.FrequencyListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.FrequencyListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.FrequencyListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.FrequencyListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.FrequencyListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.FrequencyListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/fundingPaycardVendors": {
"get": {
"tags": [
"DataLists"
],
"summary": "Gets available paycard vendors. The paycard vendors that are active and the user has access to them.",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): payroll-write ````",
"operationId": "DataListsFundingPaycardVendorsGet",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Datalists.GetFundingPaycardVendors.Result"
}
}
},
"text/csv": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Datalists.GetFundingPaycardVendors.Result"
}
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Datalists.GetFundingPaycardVendors.Result"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Datalists.GetFundingPaycardVendors.Result"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Datalists.GetFundingPaycardVendors.Result"
}
}
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Datalists.GetFundingPaycardVendors.Result"
}
}
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Datalists.GetFundingPaycardVendors.Result"
}
}
}
}
}
}
}
},
"/DataLists/genders": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Genders",
"description": "Returns a list of Genders ordered by Gender.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsGendersGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of genders to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of genders to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.GenderListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.GenderListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.GenderListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.GenderListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.GenderListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.GenderListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.GenderListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/hiers": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Hiers",
"description": "Returns a list of Hierarchies visible to the current user.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsHiersGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "Number of Hierarchies to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "Number of Hierarchies to take. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "active",
"in": "query",
"description": "Optional parameter to limit results to only inactive or active Hierarchies. Not specifying will return all visible hierarchiess for the user. It is recommended that active = 1 is used.",
"style": "form",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.HierListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.HierListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.HierListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.HierListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.HierListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.HierListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.HierListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/howheardof": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get How Heard Of List",
"description": "Returns a list of How Heard Of values ordered by the HowHeardOf column.\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsHowheardofGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of permissions to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of permissions to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "active",
"in": "query",
"description": "Optional parameter to limit list to only inactive or active items. Do not specify to obtain all items.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "originTypeId",
"in": "query",
"description": "Optional parameter to limit list to a specific origin type. Supported origin types are 1 (Employee), 2 (Customer), 3 (Contact).",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "IsWebPublic",
"in": "query",
"description": "Optional parameter to limit list to only interest codes flagged as web public. \r\n Do not specify to obtain both web public and internal interest codes",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "culture",
"in": "query",
"description": "Optional parameter to pull locale specific interest codes. If a translation\r\n does not exist, then the system will fallback to the system default locale. Do not specify to only\r\n obtain the system default translations for each interest code.",
"style": "form",
"schema": {
"maxLength": 20,
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.HowHeardOfListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.HowHeardOfListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.HowHeardOfListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.HowHeardOfListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.HowHeardOfListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.HowHeardOfListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.HowHeardOfListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/interestcodes": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Interest Codes",
"description": "Returns a list of Interest Codes for an origin type ordered by Interest Code.\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsInterestcodesGet",
"parameters": [
{
"name": "originTypeId",
"in": "query",
"description": "The origin type to obtain interest codes for. Supported origin types are 1 (Employee), 2 (Customer), 3 (Contact), 8 (Order), 12 (Vendor Contact), and 23 (Vendor).",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "active",
"in": "query",
"description": "Optional parameter to limit list to only inactive or active items. \r\n Do not specify to obtain both active and inactive codes.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "restrictToWebPublic",
"in": "query",
"description": "Optional parameter to limit list to only interest codes flagged as web public. \r\n Do not specify to obtain both web public and internal interest codes",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "culture",
"in": "query",
"description": "Optional parameter to pull locale specific interest codes. If a translation\r\n does not exist, then the system will fallback to the system default locale. Do not specify to only\r\n obtain the system default translations for each interest code.",
"style": "form",
"schema": {
"maxLength": 20,
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.InterestCodeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.InterestCodeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.InterestCodeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.InterestCodeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.InterestCodeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.InterestCodeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.InterestCodeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/InterestCodeSubCategories": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Interest Code SubCategories",
"description": "\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsInterestCodeSubCategoriesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "isActive",
"in": "query",
"description": "Optional parameter to limit list to only inactive or active items. \r\n Defaults to filter on active subcategories.",
"style": "form",
"schema": {
"type": "boolean",
"default": true
}
},
{
"name": "isWebPublic",
"in": "query",
"description": "Optional parameter to limit list to only interest code subcategories flagged as web public. \r\n Defaults to filter on both web public and internal subcategories.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "culture",
"in": "query",
"description": "Optional parameter to pull locale specific interest code subcategories. If a translation\r\n does not exist, then the system will fallback to the system default locale. Do not specify to only\r\n obtain the system default translations for each interest code subcategory.",
"style": "form",
"schema": {
"maxLength": 20,
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.InterestCodeSubCategoryList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.InterestCodeSubCategoryList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.InterestCodeSubCategoryList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.InterestCodeSubCategoryList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.InterestCodeSubCategoryList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.InterestCodeSubCategoryList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.InterestCodeSubCategoryList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/interviews/questionCategories": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Interview Question Categories",
"description": "Returns a list of Interview Question Categories ordered alpabetically by category name.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsInterviewsQuestionCategoriesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of question categories to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of question categories to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "includeInactive",
"in": "query",
"description": "Boolean to determine whether to include inactive question categories. Inactive categories are omitted from results unless this is set to true.",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.InterviewQuestionCategoryList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.InterviewQuestionCategoryList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.InterviewQuestionCategoryList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.InterviewQuestionCategoryList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.InterviewQuestionCategoryList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.InterviewQuestionCategoryList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.InterviewQuestionCategoryList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/interviews/questionCategories/{categoryId}/questions": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Interview Questions by Category",
"description": "Returns a list of Interview Questions ordered by question sort order.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsInterviewsQuestionCategoriesByCategoryIdQuestionsGet",
"parameters": [
{
"name": "categoryId",
"in": "path",
"description": "The Id of the category to get questions for.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of question categories to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of question categories to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "includeInactive",
"in": "query",
"description": "Boolean to determine whether to include inactive question. Inactive questions are omitted from results unless this is set to true.",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.InterviewQuestionsByCategoryIdList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.InterviewQuestionsByCategoryIdList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.InterviewQuestionsByCategoryIdList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.InterviewQuestionsByCategoryIdList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.InterviewQuestionsByCategoryIdList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.InterviewQuestionsByCategoryIdList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.InterviewQuestionsByCategoryIdList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/interviews/questionTypes": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Interview Question Types",
"description": "Returns a list of Interview Question Types ordered alpabetically by question type.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsInterviewsQuestionTypesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of question types to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of question types to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.InterviewQuestionTypeList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.InterviewQuestionTypeList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.InterviewQuestionTypeList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.InterviewQuestionTypeList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.InterviewQuestionTypeList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.InterviewQuestionTypeList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.InterviewQuestionTypeList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/invoiceEmailTemplates": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Invoice Email Templates",
"description": "Returns a list of Invoice Email Templates ordered by Report Name.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsInvoiceEmailTemplatesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.InvoiceEmailTemplateListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.InvoiceEmailTemplateListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.InvoiceEmailTemplateListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.InvoiceEmailTemplateListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.InvoiceEmailTemplateListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.InvoiceEmailTemplateListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.InvoiceEmailTemplateListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/invoiceHandling": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Invoice Handling List",
"description": "Returns a list of Invoice Handling ordeded by code.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsInvoiceHandlingGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of invoice handling types to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of invoice handling types to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.InvoiceHandlingListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.InvoiceHandlingListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.InvoiceHandlingListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.InvoiceHandlingListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.InvoiceHandlingListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.InvoiceHandlingListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.InvoiceHandlingListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/InvoiceHoldCodes": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Invoice Hold Codes",
"description": "Returns a list of Invoice Hold Codes ordered by Code.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsInvoiceHoldCodesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Datalists.InvoiceHoldCodeList.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Datalists.InvoiceHoldCodeList.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Datalists.InvoiceHoldCodeList.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Datalists.InvoiceHoldCodeList.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Datalists.InvoiceHoldCodeList.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Datalists.InvoiceHoldCodeList.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Datalists.InvoiceHoldCodeList.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/invoiceLineItemDetails": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Invoice Line Item Detail List",
"description": "Returns a list of Invoice Line Item Details ordered by Invoice Line Item Detail.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsInvoiceLineItemDetailsGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CustomerInvoiceLineItemDetailListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CustomerInvoiceLineItemDetailListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CustomerInvoiceLineItemDetailListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CustomerInvoiceLineItemDetailListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CustomerInvoiceLineItemDetailListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CustomerInvoiceLineItemDetailListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CustomerInvoiceLineItemDetailListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/invoiceReports": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Invoice Reports",
"description": "Returns a list of Invoice Reports ordered by Report Name.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsInvoiceReportsGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.InvoiceReportListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.InvoiceReportListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.InvoiceReportListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.InvoiceReportListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.InvoiceReportListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.InvoiceReportListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.InvoiceReportListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/invoicingMethods": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Invoicing Methods",
"description": "Returns a list of Invoicing Methods ordered by the sort order in the database.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsInvoicingMethodsGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.InvoicingMethodListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.InvoicingMethodListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.InvoicingMethodListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.InvoicingMethodListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.InvoicingMethodListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.InvoicingMethodListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.InvoicingMethodListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/jobOrderCandidateStatuses": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Job Order Candidate Statuses",
"description": "Returns a list of Job Order Candidate Statuses ordered with the default status first and then by Job Order Candidate Status.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsJobOrderCandidateStatusesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.JobOrderCandidateStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.JobOrderCandidateStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.JobOrderCandidateStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.JobOrderCandidateStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.JobOrderCandidateStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.JobOrderCandidateStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.JobOrderCandidateStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/jobordercompanystatuses": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Job Order Company Statuses",
"description": "Returns a list of Job Order Company Statuses available in the system.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsJobordercompanystatusesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of statuses to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of statuses to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.JobOrderCompanyStatusList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.JobOrderCompanyStatusList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.JobOrderCompanyStatusList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.JobOrderCompanyStatusList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.JobOrderCompanyStatusList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.JobOrderCompanyStatusList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.JobOrderCompanyStatusList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/jobOrderDurations": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Job Order Durations",
"description": "Returns a list of Job Order Durations ordered with the default first and then by Job Order Duration.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsJobOrderDurationsGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.JobOrderDurationListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.JobOrderDurationListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.JobOrderDurationListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.JobOrderDurationListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.JobOrderDurationListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.JobOrderDurationListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.JobOrderDurationListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/jobOrderStatuses": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Job Order Statuses",
"description": "Returns a list of Job Order Statuses ordered by Job Order Status.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsJobOrderStatusesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.JobOrderStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.JobOrderStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.JobOrderStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.JobOrderStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.JobOrderStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.JobOrderStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.JobOrderStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/jobTitles": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Job Titles",
"description": "Returns a list of Job Titles ordered by Title.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsJobTitlesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of job titles to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of job titles to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "isActive",
"in": "query",
"description": "Optional parameter to limit list to only inactive or active job titles. Leave this parameter blank to obtain all job titles.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "filter",
"in": "query",
"description": "An optional parameter that if provided will only return the job titles that match a specified text.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "skillCodeFilter",
"in": "query",
"description": "An optional parameter that if provided will only return the job titles whose skill codes start with the specified text.",
"style": "form",
"schema": {
"maxLength": 1,
"minLength": 0,
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.JobTitleListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.JobTitleListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.JobTitleListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.JobTitleListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.JobTitleListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.JobTitleListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.JobTitleListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/jobTitles/{jobTitleId}": {
"get": {
"tags": [
"DataLists"
],
"summary": "Gets the details for a specified job title.",
"description": "Returns the Job Titles details.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsJobTitlesByJobTitleIdGet",
"parameters": [
{
"name": "jobTitleId",
"in": "path",
"description": "The Id of the job title.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.JobTitleListQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.JobTitleListQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.JobTitleListQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.JobTitleListQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.JobTitleListQuery.Result"
}
}
}
}
}
}
},
"/DataLists/kpiReportTypes": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Kpi Report Types",
"description": "Returns a list of valid Kpi Report Types.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): report-read ````",
"operationId": "DataListsKpiReportTypesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to take. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.KpiReportTypesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.KpiReportTypesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.KpiReportTypesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.KpiReportTypesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.KpiReportTypesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.KpiReportTypesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.KpiReportTypesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/locales": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Locales",
"description": "Returns a list of Locales ordered by Locale Id.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsLocalesGet",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.LocaleListQuery.Result"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.LocaleListQuery.Result"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.LocaleListQuery.Result"
}
}
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.LocaleListQuery.Result"
}
}
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.LocaleListQuery.Result"
}
}
}
}
}
}
}
},
"/DataLists/localTaxes": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Local Taxes",
"description": "Returns a list of valid combinations of county, school district, and municipality taxes for the specified postal code.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsLocalTaxesGet",
"parameters": [
{
"name": "postalCode",
"in": "query",
"description": "Only taxes combinations available for the specified postcal code will be returned.",
"required": true,
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "postalCodeCountryCode",
"in": "query",
"description": "Defines the country the postal code is for. Valid countries can be found in the Countries Datalist.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "isForEmployeeTaxes",
"in": "query",
"description": "Some local tax behavior is dependent on whether or not the tax is set up on the employee or elsewhere such as a worksite.",
"required": true,
"style": "form",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.LocalTaxJurisdictionsByPostalCodeQuery.Result"
}
}
},
"text/csv": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.LocalTaxJurisdictionsByPostalCodeQuery.Result"
}
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.LocalTaxJurisdictionsByPostalCodeQuery.Result"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.LocalTaxJurisdictionsByPostalCodeQuery.Result"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.LocalTaxJurisdictionsByPostalCodeQuery.Result"
}
}
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.LocalTaxJurisdictionsByPostalCodeQuery.Result"
}
}
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.LocalTaxJurisdictionsByPostalCodeQuery.Result"
}
}
}
}
}
}
}
},
"/DataLists/maritalTaxStatuses": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Marital Tax Statuses",
"description": "Returns a list of Marital Tax Statuses ordered by Marital Tax Status.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsMaritalTaxStatusesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of statuses to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of statuses to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.MaritalTaxStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.MaritalTaxStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.MaritalTaxStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.MaritalTaxStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.MaritalTaxStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.MaritalTaxStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.MaritalTaxStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/messageActions": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Message Actions List",
"description": "Returns a list of Message Actions ordered by Action.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsMessageActionsGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of message actions to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of message actions to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "active",
"in": "query",
"description": "Optional parameter to limit the to only inactive or active actions. Do not specify to obtain all actions.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "originTypeId",
"in": "query",
"description": "Optional parameter to limit list to a specific origin type. Supported origin types are 1 (Employee), 2 (Customer), and 3 (Contact).",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "messageActionTypeId",
"in": "query",
"description": "Optional parameter to limit list to a specific message action type. Leave null to return all values. \r\n Valid values can be found in the Message Action Types datalist. ref: datalists/messageActionTypes",
"style": "form",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.MessageActionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.MessageActionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.MessageActionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.MessageActionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.MessageActionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.MessageActionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.MessageActionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/messageActionTypes": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Message Action Types",
"description": "Returns a list of Message Action Types ordered by Type.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsMessageActionTypesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of message action types to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of message action types to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.MessageActionTypeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.MessageActionTypeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.MessageActionTypeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.MessageActionTypeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.MessageActionTypeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.MessageActionTypeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.MessageActionTypeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/monthlyBillCycles": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Monthly Bill Cycles",
"description": "Returns a list of Monthly Bill Cycles ordered by Monthly Bill Cycle Id.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsMonthlyBillCyclesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.MonthlyBillCycleListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.MonthlyBillCycleListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.MonthlyBillCycleListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.MonthlyBillCycleListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.MonthlyBillCycleListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.MonthlyBillCycleListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.MonthlyBillCycleListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/monthlyPayCycles": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Monthly Pay Cycles",
"description": "Returns a list of Monthly Pay Cycles ordered by Monthly Pay Cycle Id.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): payroll-read ````",
"operationId": "DataListsMonthlyPayCyclesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of cycles to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of cycles to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.MonthlyPayCyclesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.MonthlyPayCyclesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.MonthlyPayCyclesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.MonthlyPayCyclesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.MonthlyPayCyclesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.MonthlyPayCyclesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.MonthlyPayCyclesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/monthlyPayCyclesByPayPeriod": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Monthly Pay Cycles by Pay Period",
"description": "Returns a list of Monthly Pay Cycles by Pay Period ordered by Pay Cycle Id.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): payroll-read ````",
"operationId": "DataListsMonthlyPayCyclesByPayPeriodGet",
"parameters": [
{
"name": "payPeriodId",
"in": "query",
"description": "The chosen pay period id.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of cycles to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of cycles to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.MonthlyPayCyclesListByPayPeriodQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.MonthlyPayCyclesListByPayPeriodQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.MonthlyPayCyclesListByPayPeriodQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.MonthlyPayCyclesListByPayPeriodQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.MonthlyPayCyclesListByPayPeriodQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.MonthlyPayCyclesListByPayPeriodQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.MonthlyPayCyclesListByPayPeriodQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/multiplierCodes": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Multiplier Codes",
"description": "Returns a list of Multiplier Codes with the default first and then orderd by Multiplier Code.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsMultiplierCodesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of multiplier codes to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of multiplier codes to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "isActive",
"in": "query",
"description": "An optional parameter that if left blank will allow all codes back regardless of if they are active or not. If specified only codes whose values match that specified will be returned.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "filter",
"in": "query",
"description": "An optional parameter that if provided will only return multiplier codes that begin with the specified text.",
"style": "form",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.MultiplierCodeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.MultiplierCodeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.MultiplierCodeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.MultiplierCodeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.MultiplierCodeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.MultiplierCodeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.MultiplierCodeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/multiplierCodes/{multiplierCodeId}": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Multiplier Code",
"description": "Returns a multiplier code by specified multiplier code Id.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsMultiplierCodesByMultiplierCodeIdGet",
"parameters": [
{
"name": "multiplierCodeId",
"in": "path",
"description": "The multiplier code id to get information about.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.MultiplierCodeListQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.MultiplierCodeListQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.MultiplierCodeListQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.MultiplierCodeListQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.MultiplierCodeListQuery.Result"
}
}
}
},
"404": {
"description": "Not Found"
}
}
}
},
"/DataLists/municipalityIncomeTaxJurisdictions": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Municipality Income Tax Jurisdictions",
"description": "Returns a list of Municipality Income Tax Jurisdictions ordered by Municipality.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsMunicipalityIncomeTaxJurisdictionsGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of jurisdictions to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of jurisdictions to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "taxRegion",
"in": "query",
"description": "Used to restrict the list of jurisdictions to those levied within the specified tax region. A list of Regions can be found in the Regions Datalist.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "filter",
"in": "query",
"description": "An optional parameter used to filter the results. Only Jurisdictions whose Municipality or Jurisdiction contain the specified string will be returned.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "taxJurisdictionId",
"in": "query",
"description": "An optional parameter used to filter the results. If provided the Tax Jurisdiction Id of a result must exactly match this parameter in order to be returned.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.MunicipalityTaxJurisdictionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.MunicipalityTaxJurisdictionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.MunicipalityTaxJurisdictionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.MunicipalityTaxJurisdictionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.MunicipalityTaxJurisdictionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.MunicipalityTaxJurisdictionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.MunicipalityTaxJurisdictionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/nameprefixes": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Name Prefixes",
"description": "Returns a list of Name Prefixes ordered by Prefix.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsNameprefixesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of prefixes to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of prefixes to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.NamePrefixListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.NamePrefixListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.NamePrefixListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.NamePrefixListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.NamePrefixListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.NamePrefixListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.NamePrefixListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/nationalIndustryClassificationSystemCodes": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get National Industry Classification System Codes",
"description": "Returns a list of National Industry Classification System Codes.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsNationalIndustryClassificationSystemCodesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "filter",
"in": "query",
"description": "An optional parameter that if provided will only return the Naics code that match the specified value",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "active",
"in": "query",
"description": "Addiitonal filter to return active or inactive codes",
"style": "form",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.NationalIndustryClassificationSystemCodeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.NationalIndustryClassificationSystemCodeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.NationalIndustryClassificationSystemCodeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.NationalIndustryClassificationSystemCodeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.NationalIndustryClassificationSystemCodeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.NationalIndustryClassificationSystemCodeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.NationalIndustryClassificationSystemCodeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/nationalities": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Nationalities",
"description": "Returns a list of Nationalities ordered by Nationality.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsNationalitiesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of nationalities to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of nationalities to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "countryCode",
"in": "query",
"description": "The country code to filter the list upon. Valid country codes can be found in the Country Codes Datalist.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.NationalityListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.NationalityListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.NationalityListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.NationalityListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.NationalityListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.NationalityListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.NationalityListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/notifications/types": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Notification Types",
"description": "Returns a list of notification types ordered by category name and the name of the notification type.\n \n```` Allows roles: ServiceRep, WebUserEmployee, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsNotificationsTypesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "originTypeId",
"in": "query",
"description": "Optional parameter used to filter types based on corresponding OriginType.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.NotificationTypesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.NotificationTypesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.NotificationTypesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.NotificationTypesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.NotificationTypesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.NotificationTypesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.NotificationTypesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/ordertypes": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Order Types",
"description": "Returns a list of Order Types ordered by Order Type.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsOrdertypesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of order types to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of order types to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.OrderTypeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.OrderTypeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.OrderTypeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.OrderTypeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.OrderTypeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.OrderTypeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.OrderTypeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/overtimeFactors": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Overtime Factors",
"description": "Returns a list of Overtime Factors ordered by Overtime Factor.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsOvertimeFactorsGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.OvertimeFactorListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.OvertimeFactorListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.OvertimeFactorListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.OvertimeFactorListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.OvertimeFactorListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.OvertimeFactorListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.OvertimeFactorListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/overtimePlans": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Overtime Plans",
"description": "Returns a list of Overtime Plans ordered with the default first and then by Overtime Plan.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsOvertimePlansGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.OvertimePlanListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.OvertimePlanListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.OvertimePlanListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.OvertimePlanListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.OvertimePlanListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.OvertimePlanListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.OvertimePlanListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/parentTaxJurisdictions": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Parent Tax Jurisdictions",
"description": "Returns a list of Parent Tax Jurisdictions ordered by Parent Tax Jurisdiction.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsParentTaxJurisdictionsGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of parent jurisdictions to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of parent jurisdictions to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ParentTaxJurisdictionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ParentTaxJurisdictionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ParentTaxJurisdictionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ParentTaxJurisdictionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ParentTaxJurisdictionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ParentTaxJurisdictionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ParentTaxJurisdictionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/paycardVendors": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Paycard Vendors",
"description": "Returns a list of Paycard Vendors ordered by Paycard Vendor Name.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): payroll-read ````",
"operationId": "DataListsPaycardVendorsGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of vendors to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of vendors to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "isActive",
"in": "query",
"description": "Optional parameter to limit the list to only active or inactive vendors. Leave blank to return all.",
"style": "form",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.PaycardVendorsListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.PaycardVendorsListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.PaycardVendorsListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.PaycardVendorsListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.PaycardVendorsListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.PaycardVendorsListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.PaycardVendorsListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/paycheckDeliveryCodes": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Paycheck Delivery Codes",
"description": "Returns a list of Paycheck Delivery Codes ordered by Paycheck Delivery Code.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsPaycheckDeliveryCodesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of codes to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of codes to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.PaycheckDeliveryCodeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.PaycheckDeliveryCodeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.PaycheckDeliveryCodeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.PaycheckDeliveryCodeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.PaycheckDeliveryCodeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.PaycheckDeliveryCodeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.PaycheckDeliveryCodeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/payCodes": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Pay Codes",
"description": "Returns a list of Pay Codes ordered by the Pay Code.\n \n```` Allows roles: ServiceRep, WebUserEmployee, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsPayCodesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.PayCodeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.PayCodeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.PayCodeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.PayCodeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.PayCodeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.PayCodeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.PayCodeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/PayHoldCodes": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Pay Hold Codes",
"description": "Returns a list of Pay Hold Codes ordered by Code.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsPayHoldCodesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Datalists.PayHoldCodeList.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Datalists.PayHoldCodeList.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Datalists.PayHoldCodeList.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Datalists.PayHoldCodeList.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Datalists.PayHoldCodeList.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Datalists.PayHoldCodeList.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Datalists.PayHoldCodeList.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/paymentTerms": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Payment Terms",
"description": "Returns a list of Payment Terms visible to the current user.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsPaymentTermsGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of payment terms to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of payment terms to take. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.PaymentTermsListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.PaymentTermsListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.PaymentTermsListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.PaymentTermsListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.PaymentTermsListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.PaymentTermsListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.PaymentTermsListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/payPeriods": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Pay Periods",
"description": "Returns a list of Pay Periods ordered by the number of Pay Periods.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsPayPeriodsGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.PayPeriodDataListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.PayPeriodDataListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.PayPeriodDataListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.PayPeriodDataListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.PayPeriodDataListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.PayPeriodDataListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.PayPeriodDataListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/payTransparency/collectionTypeBasises": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Pay Transparancy Collection Type Basises",
"description": "Returns a list of Pay Transparancy Collection Type Basises.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsPayTransparencyCollectionTypeBasisesGet",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.PayTransparencyCollectionTypeBasisListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.PayTransparencyCollectionTypeBasisListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.PayTransparencyCollectionTypeBasisListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.PayTransparencyCollectionTypeBasisListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.PayTransparencyCollectionTypeBasisListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.PayTransparencyCollectionTypeBasisListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.PayTransparencyCollectionTypeBasisListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/payTransparency/collectionTypes": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Pay Transparancy Collection Types",
"description": "Returns a list of Pay Transparancy Collection Types.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsPayTransparencyCollectionTypesGet",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.PayTransparencyCollectionTypeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.PayTransparencyCollectionTypeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.PayTransparencyCollectionTypeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.PayTransparencyCollectionTypeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.PayTransparencyCollectionTypeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.PayTransparencyCollectionTypeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.PayTransparencyCollectionTypeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/payTransparency/genders": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Pay Transparency Genders",
"description": "Returns a list of Pay Transparancy Genders.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsPayTransparencyGendersGet",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.PayTransparencyGenderListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.PayTransparencyGenderListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.PayTransparencyGenderListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.PayTransparencyGenderListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.PayTransparencyGenderListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.PayTransparencyGenderListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.PayTransparencyGenderListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/payTransparency/races": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Pay Transparency Races",
"description": "Returns a list of Pay Transparancy Races.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsPayTransparencyRacesGet",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.PayTransparencyRaceListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.PayTransparencyRaceListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.PayTransparencyRaceListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.PayTransparencyRaceListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.PayTransparencyRaceListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.PayTransparencyRaceListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.PayTransparencyRaceListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/pennsylvaniaLocalServiceTaxes": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Pennsylvania Local Service Taxes",
"description": "Returns a list of Pennsylvania Local Service Taxes ordered by the Pennsylvania LST.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsPennsylvaniaLocalServiceTaxesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "pennsylvaniaLocalServiceTaxId",
"in": "query",
"description": "An optional parameter used to filter the results. Only the item with the specified Id will be returned.",
"style": "form",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "filter",
"in": "query",
"description": "An optional parameter used to filter the results. Only items whose PennsylvaniaLst contain the specified string will be returned.",
"style": "form",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.PennsylvaniaLocalServiceTaxListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.PennsylvaniaLocalServiceTaxListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.PennsylvaniaLocalServiceTaxListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.PennsylvaniaLocalServiceTaxListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.PennsylvaniaLocalServiceTaxListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.PennsylvaniaLocalServiceTaxListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.PennsylvaniaLocalServiceTaxListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/pennsylvaniaPsdCodes": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Pennsylvania PSD Codes",
"description": "Returns a list of Pennsylvania PSD Codes ordered by the PSD Code.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsPennsylvaniaPsdCodesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of codes to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of codes to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "filter",
"in": "query",
"description": "An optional parameter used to filter the results. Only Jurisdictions whose PSD Code, School District or Municipality contain the specified string will be returned.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "psdCode",
"in": "query",
"description": "An optional parameter used to filter the results. If provided the PSD Code of a result must exactly match this parameter in order to be returned.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "taxMunicipalityJurisdictionId",
"in": "query",
"description": "An optional parameter used to filter the results. Only PSD Codes associated with the specified municipality tax jurisdiction will be returned.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "taxSchoolDistrictJurisdictionId",
"in": "query",
"description": "An optional parameter used to filter the results. Only PSD Codes associated with the specified school district tax jurisdiction will be returned.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.PennsylvaniaPsdCodesListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.PennsylvaniaPsdCodesListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.PennsylvaniaPsdCodesListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.PennsylvaniaPsdCodesListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.PennsylvaniaPsdCodesListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.PennsylvaniaPsdCodesListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.PennsylvaniaPsdCodesListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/permissions": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Permissions",
"description": "Returns a list of Permissions which can be granted to roles and users ordered by Name.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsPermissionsGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of permissions to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of permissions to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.PermissionsListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.PermissionsListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.PermissionsListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.PermissionsListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.PermissionsListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.PermissionsListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.PermissionsListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/productInstances": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Product Instances",
"description": "Returns a list of Product Instances.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsProductInstancesGet",
"parameters": [
{
"name": "productId",
"in": "query",
"description": "The type of product to be returned. Leave null for all. Enterprise = 1, Beyond = 2, WebCenter = 4, HrCenter = 8, Companion = 16.",
"style": "form",
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Enums.Products"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "includeDeprecated",
"in": "query",
"description": "Set to true if you want the result to include deprecated product instances.",
"style": "form",
"schema": {
"type": "boolean",
"default": true
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ProductInstanceListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ProductInstanceListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ProductInstanceListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ProductInstanceListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ProductInstanceListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ProductInstanceListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ProductInstanceListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/products": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Products",
"description": "Returns a list of Products ordered by ProductId.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsProductsGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ProductList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ProductList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ProductList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ProductList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ProductList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ProductList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ProductList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/proofingErrorTypeSeverities": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Proofing Error Type Severities",
"description": "This endpoint retrieves all available proofing error type severities.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsProofingErrorTypeSeveritiesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ProofingErrorTypeSeverities.ProofingErrorTypeSeverities.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ProofingErrorTypeSeverities.ProofingErrorTypeSeverities.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ProofingErrorTypeSeverities.ProofingErrorTypeSeverities.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ProofingErrorTypeSeverities.ProofingErrorTypeSeverities.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ProofingErrorTypeSeverities.ProofingErrorTypeSeverities.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ProofingErrorTypeSeverities.ProofingErrorTypeSeverities.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ProofingErrorTypeSeverities.ProofingErrorTypeSeverities.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/prospectStatuses": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Prospect Statuses",
"description": "Returns a list of Prospect Statuses ordered by ProspectStatus.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsProspectStatusesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "restrictToActiveStatuses",
"in": "query",
"description": "An optional parameter that defaults to false. If set to true, only active statuses will be included in the results.",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ProspectStatusList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ProspectStatusList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ProspectStatusList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ProspectStatusList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ProspectStatusList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ProspectStatusList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ProspectStatusList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/rapid/fundingAccounts": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get rapid's funding accounts based on user's hierarchy.",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): payroll-write ````",
"operationId": "DataListsRapidFundingAccountsGet",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Datalists.GetRapidFundingAccounts.Result"
}
}
},
"text/csv": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Datalists.GetRapidFundingAccounts.Result"
}
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Datalists.GetRapidFundingAccounts.Result"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Datalists.GetRapidFundingAccounts.Result"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Datalists.GetRapidFundingAccounts.Result"
}
}
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Datalists.GetRapidFundingAccounts.Result"
}
}
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Datalists.GetRapidFundingAccounts.Result"
}
}
}
}
}
}
}
},
"/DataLists/reasonCodes": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Reason Codes",
"description": "Returns a list of Reason Codes.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsReasonCodesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of reason codes to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of reason codes to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.SalesTeamListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.SalesTeamListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.SalesTeamListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.SalesTeamListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.SalesTeamListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.SalesTeamListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.SalesTeamListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/regionIncomeTaxJurisdictions": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Region Income Tax Jurisdictions",
"description": "Returns a list of Region Income Tax Jurisdictions ordered by Jurisdiction.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsRegionIncomeTaxJurisdictionsGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of jurisdictions to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of jurisdictions to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "taxRegion",
"in": "query",
"description": "Used to restrict the list of jurisdictions to those levied by the specified tax region. A list of Regions can be found in the Regions Datalist.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "taxJurisdictionId",
"in": "query",
"description": "An optional parameter used to filter the results. If provided the Tax Jurisdiction Id of a result must exactly match this parameter in order to be returned.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.RegionTaxJurisdictionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.RegionTaxJurisdictionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.RegionTaxJurisdictionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.RegionTaxJurisdictionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.RegionTaxJurisdictionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.RegionTaxJurisdictionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.RegionTaxJurisdictionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/regions": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Regions",
"description": "Returns a list of Regions ordered by Country Code then Region.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsRegionsGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of regions to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of regions to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "countryCode",
"in": "query",
"description": "Optional parameter to limit list to a specific country. Valid Country Codes can be found in the Countries Datalist.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.RegionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.RegionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.RegionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.RegionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.RegionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.RegionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.RegionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/remoteWorkStatus": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Remote Work Status List",
"description": "Returns a list Remote work statuses.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsRemoteWorkStatusGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.RemoteWorkStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.RemoteWorkStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.RemoteWorkStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.RemoteWorkStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.RemoteWorkStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.RemoteWorkStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.RemoteWorkStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/reportGroups": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Report Groups",
"description": "Returns a list of Report Groups visible to the current user based off of their Role.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsReportGroupsGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ReportGroupListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ReportGroupListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ReportGroupListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ReportGroupListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ReportGroupListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ReportGroupListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ReportGroupListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/requiredDocumentAuthorityList": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Required Document Authorities",
"description": "Returns a list of Authorities for required documents, includes ALL as the first item from the enum.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsRequiredDocumentAuthorityListGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.RequiredDocumentAuthorityList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.RequiredDocumentAuthorityList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.RequiredDocumentAuthorityList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.RequiredDocumentAuthorityList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.RequiredDocumentAuthorityList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.RequiredDocumentAuthorityList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.RequiredDocumentAuthorityList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/requiredDocumentStatuses": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Required Document Statuses",
"description": "Returns a list of active Required Document statuses ordered by status.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsRequiredDocumentStatusesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of required document statuses to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of required document statuses to take. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.GetRequiredDocumentStatus.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.GetRequiredDocumentStatus.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.GetRequiredDocumentStatus.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.GetRequiredDocumentStatus.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.GetRequiredDocumentStatus.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.GetRequiredDocumentStatus.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.GetRequiredDocumentStatus.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/requiredDocumentsTypes": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Required Document Types",
"description": "Returns a list of Required Document Types filtered by Category if specified.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsRequiredDocumentsTypesGet",
"parameters": [
{
"name": "requiredDocumentTypeCategoryId",
"in": "query",
"description": "The required doc type's category.",
"style": "form",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "isActive",
"in": "query",
"description": "Whether or not the type is active.",
"style": "form",
"schema": {
"type": "boolean",
"default": true
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.RequiredDocumentTypeList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.RequiredDocumentTypeList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.RequiredDocumentTypeList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.RequiredDocumentTypeList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.RequiredDocumentTypeList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.RequiredDocumentTypeList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.RequiredDocumentTypeList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/requiredDocumentTypeCategories": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Required Document Type Categories",
"description": "Returns a list of Required Document Type Categories ordered by RequiredDocumentTypeCategory.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsRequiredDocumentTypeCategoriesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to take. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.GetRequiredDocumentCategories.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.GetRequiredDocumentCategories.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.GetRequiredDocumentCategories.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.GetRequiredDocumentCategories.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.GetRequiredDocumentCategories.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.GetRequiredDocumentCategories.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.GetRequiredDocumentCategories.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/resume/filetypes": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Resume Template File Types",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsResumeFiletypesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of the file types to skip.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of the file types to take.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ResumeFileTypeList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ResumeFileTypeList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ResumeFileTypeList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ResumeFileTypeList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ResumeFileTypeList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ResumeFileTypeList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ResumeFileTypeList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/resume/templates": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Resume Templates",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsResumeTemplatesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of the resume templates to skip.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of the resume templates to take.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ResumeTemplateListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ResumeTemplateListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ResumeTemplateListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ResumeTemplateListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ResumeTemplateListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ResumeTemplateListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ResumeTemplateListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/routingNumbers": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Routing Numbers",
"description": "Returns a list of Routing Numbers currently stored in the system. This is sorted by Electronic Pay Bank Type Id and then Routing Number.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): payroll-read ````",
"operationId": "DataListsRoutingNumbersGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of routing numbers to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of routing numbers to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "isActive",
"in": "query",
"description": "Optional parameter to limit the list to only inactive or active numbers. Leave this parameter blank to obtain all values.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "electronicPayBankTypeId",
"in": "query",
"description": "Optional parameter to limit the list to specific electronic pay bank types. Leave this parameter blank to obtain all values. Valid Electronic Pay Bank Types can be found in the Electronic Pay Bank Types Datalist.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "routingNumber",
"in": "query",
"description": "Optional parameter to limit the list to only routing numbers that start with the supplied value. Leave this parameter blank to obtain all values.",
"style": "form",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.RoutingNumbersListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.RoutingNumbersListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.RoutingNumbersListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.RoutingNumbersListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.RoutingNumbersListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.RoutingNumbersListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.RoutingNumbersListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/salesPipelineStatuses": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Sales Pipeline Statuses",
"description": "Returns a list of Sales Pipeline Statuses ordered by Minimum Progress.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsSalesPipelineStatusesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of statuses to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of statuses to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.SalesPipelineStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.SalesPipelineStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.SalesPipelineStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.SalesPipelineStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.SalesPipelineStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.SalesPipelineStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.SalesPipelineStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/salesTaxes": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Sales Taxes",
"description": "Returns a list of Sales Taxes including their base percentages.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsSalesTaxesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of sales taxes to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of sales taxes to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "asOfDate",
"in": "query",
"description": "Only taxes that are applicable as of the specified date will be returned.",
"required": true,
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "postalCode",
"in": "query",
"description": "An optional parameter that limits the results set to only sales taxes linked to the specified postal code. Must be used with postalCodeCountryCode.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "postalCodeCountryCode",
"in": "query",
"description": "An optional parameter that lets the system know how to handle the postal code. Must be used with postalCode.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "filter",
"in": "query",
"description": "An optional parameter that limits the results to sales taxes whose jurisdictions begin with the provided string.",
"style": "form",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TempWorks.TwApi.Common.Models.SalesTax, TempWorks.TwApi.Common.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TempWorks.TwApi.Common.Models.SalesTax, TempWorks.TwApi.Common.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TempWorks.TwApi.Common.Models.SalesTax, TempWorks.TwApi.Common.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TempWorks.TwApi.Common.Models.SalesTax, TempWorks.TwApi.Common.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TempWorks.TwApi.Common.Models.SalesTax, TempWorks.TwApi.Common.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TempWorks.TwApi.Common.Models.SalesTax, TempWorks.TwApi.Common.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TempWorks.TwApi.Common.Models.SalesTax, TempWorks.TwApi.Common.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/salesTaxTypes": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Sales Tax types",
"description": "Returns a list of Sales Tax types.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsSalesTaxTypesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.SalesTaxTypesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.SalesTaxTypesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.SalesTaxTypesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.SalesTaxTypesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.SalesTaxTypesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.SalesTaxTypesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.SalesTaxTypesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/salesTeams": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Sales Teams",
"description": "Returns a list of Sales Teams ordered by Team Name.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsSalesTeamsGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of sales teams to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of sales teams to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "activeOnly",
"in": "query",
"description": "Optional parameter to limit the list to only active or inactive accounts. Leave this parameter blank to obtain all values.",
"style": "form",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.SalesTeamListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.SalesTeamListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.SalesTeamListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.SalesTeamListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.SalesTeamListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.SalesTeamListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.SalesTeamListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/schoolDistrictIncomeTaxJurisdictions": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get School District Income Tax Jurisdictions",
"description": "Returns a list of School District Income Tax Jurisdictions ordered by School District.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsSchoolDistrictIncomeTaxJurisdictionsGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of jurisdictions to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of jurisdictions to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "taxRegion",
"in": "query",
"description": "Used to restrict the list of jurisdictions to those levied within the specified tax region. A list of Regions can be found in the Regions Datalist.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "filter",
"in": "query",
"description": "An optional parameter used to filter the results. Only Jurisdictions whose School District or Jurisdiction contain the specified string will be returned.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "taxJurisdictionId",
"in": "query",
"description": "An optional parameter used to filter the results. If provided the Tax Jurisdiction Id of a result must exactly match this parameter in order to be returned.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "schoolDistrictNumber",
"in": "query",
"description": "An optional parameter used to filter on School District Number.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.SchoolDistrictTaxJurisdictionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.SchoolDistrictTaxJurisdictionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.SchoolDistrictTaxJurisdictionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.SchoolDistrictTaxJurisdictionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.SchoolDistrictTaxJurisdictionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.SchoolDistrictTaxJurisdictionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.SchoolDistrictTaxJurisdictionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/securitygrouptypes": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Security Group Types",
"description": "Returns a list of Security Group Types.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsSecuritygrouptypesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of entries to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of entries to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.SecurityGroupTypeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.SecurityGroupTypeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.SecurityGroupTypeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.SecurityGroupTypeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.SecurityGroupTypeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.SecurityGroupTypeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.SecurityGroupTypeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/serviceReps": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Service Reps",
"description": "Returns a list of Service Reps ordered by Service Rep Full Name.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsServiceRepsGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of service reps to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of service reps to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "includeInactives",
"in": "query",
"description": "Set to true if you want the result to include inactive service reps.",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ServiceRepListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ServiceRepListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ServiceRepListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ServiceRepListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ServiceRepListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ServiceRepListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ServiceRepListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/serviceReps/byPermission/{permissionId}": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Service Reps visible from your current tenant who have a given permission.",
"description": "Gets a list of Service Rep who are in a security group with the provided PermissionId.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsServiceRepsByPermissionByPermissionIdGet",
"parameters": [
{
"name": "permissionId",
"in": "path",
"description": "Only members of a security group with access to this PermissionId will be returned.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ServiceRepsByPermission.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ServiceRepsByPermission.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ServiceRepsByPermission.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ServiceRepsByPermission.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ServiceRepsByPermission.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ServiceRepsByPermission.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ServiceRepsByPermission.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/serviceRepTeams": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Service Rep Teams",
"description": "Returns a list of Service Rep Teams. Teams are ordered by Name.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsServiceRepTeamsGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of teams to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of teams to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "restrictToCurrentUsersTeams",
"in": "query",
"description": "An optional parameter that defaults to false. If set to true, only teams that the user owns or is a member of will be included in the results.",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ServiceRepTeamListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ServiceRepTeamListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ServiceRepTeamListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ServiceRepTeamListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ServiceRepTeamListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ServiceRepTeamListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ServiceRepTeamListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/serviceRepTeams/{teamId}/members": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Service Rep Team Members",
"description": "Returns a list of Team Members for the specified Service Rep Team. Members are ordered by Name.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsServiceRepTeamsByTeamIdMembersGet",
"parameters": [
{
"name": "teamId",
"in": "path",
"description": "The Id of the team to which the members belong.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of team members to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of team members to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ServiceRepTeamMembersListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ServiceRepTeamMembersListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ServiceRepTeamMembersListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ServiceRepTeamMembersListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ServiceRepTeamMembersListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ServiceRepTeamMembersListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ServiceRepTeamMembersListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/shifts": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Shifts",
"description": "Returns a list of visible Shifts.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsShiftsGet",
"parameters": [
{
"name": "isActive",
"in": "query",
"description": "An optional parameter used to filter on whether or not a Shift is active.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "searchText",
"in": "query",
"description": "An optional parameter which will limit results to shifts whose name starts with the provided case-insensitive string.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to take. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "shiftId",
"in": "query",
"description": "An optional parameter used to filter results to a single Shift.",
"style": "form",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ShiftList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ShiftList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ShiftList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ShiftList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ShiftList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ShiftList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ShiftList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/skillCodeCategories": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Skill Code Categories",
"description": "Returns a list of Skill Code Categories ordered by Skill Code Category Name.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsSkillCodeCategoriesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of skill code categories to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of skill code categories to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.SkillCodeCategoryListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.SkillCodeCategoryListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.SkillCodeCategoryListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.SkillCodeCategoryListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.SkillCodeCategoryListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.SkillCodeCategoryListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.SkillCodeCategoryListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/smtpEncryptionMethods": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Smtp Encryption Methods",
"description": "Returns a list of Smtp Encryption Methods.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): email-read ````",
"operationId": "DataListsSmtpEncryptionMethodsGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "Number of methods to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "Number of methods to take. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.SmtpEncryptionMethodsList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.SmtpEncryptionMethodsList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.SmtpEncryptionMethodsList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.SmtpEncryptionMethodsList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.SmtpEncryptionMethodsList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.SmtpEncryptionMethodsList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.SmtpEncryptionMethodsList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/socCodes": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get a list of available Standard Occupational Classification (SOC) codes.",
"description": "Returns a list of SOC Codes.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsSocCodesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to take. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.SocCodesList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.SocCodesList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.SocCodesList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.SocCodesList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.SocCodesList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.SocCodesList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.SocCodesList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/sovrenJobBoards": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Job Boards",
"description": "Returns a list of job boards used for sourcing resumes.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsSovrenJobBoardsGet",
"parameters": [
{
"name": "includeInactive",
"in": "query",
"description": "Whether to include inactive job boards.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.SovrenJobBoardsList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.SovrenJobBoardsList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.SovrenJobBoardsList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.SovrenJobBoardsList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.SovrenJobBoardsList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.SovrenJobBoardsList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.SovrenJobBoardsList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/sutaTaxJurisdictions": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get SUTA Tax Jurisdictions",
"description": "Returns a list of SUTA Tax Jurisdictions ordered by the Jurisdiction.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsSutaTaxJurisdictionsGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of jurisdictions to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of jurisdictions to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "taxJurisdictionId",
"in": "query",
"description": "An optional parameter used to filter the results. If provided the Tax Jurisdiction Id of a result must exactly match this parameter in order to be returned.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.SutaTaxJurisdictionListQuery.Result"
}
}
},
"text/csv": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.SutaTaxJurisdictionListQuery.Result"
}
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.SutaTaxJurisdictionListQuery.Result"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.SutaTaxJurisdictionListQuery.Result"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.SutaTaxJurisdictionListQuery.Result"
}
}
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.SutaTaxJurisdictionListQuery.Result"
}
}
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.SutaTaxJurisdictionListQuery.Result"
}
}
}
}
}
}
}
},
"/DataLists/taxJurisdictionLocations": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Tax Jurisdiction Locations",
"description": "Returns a list of Tax Jurisdictions filtered by postal code, country code, and entity\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsTaxJurisdictionLocationsGet",
"parameters": [
{
"name": "CountryCode",
"in": "query",
"description": "An optional parameter used to restrict the list of tax jurisdiction locations based on the jurisdiction country code.\r\nDefaults to 840 (U.S.) when not specified.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Entity",
"in": "query",
"description": "An optional parameter used to provide additional locations depending on the passed entity",
"style": "form",
"schema": {
"pattern": "^(order|employee|customer)?$",
"type": "string"
}
},
{
"name": "PostalCode",
"in": "query",
"description": "Filters the jurisdiction locations that are returned",
"required": true,
"style": "form",
"schema": {
"maxLength": 10,
"minLength": 1,
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.TaxJurisdictionLocationListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.TaxJurisdictionLocationListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.TaxJurisdictionLocationListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.TaxJurisdictionLocationListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.TaxJurisdictionLocationListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.TaxJurisdictionLocationListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.TaxJurisdictionLocationListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/taxJurisdictions": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Tax Jurisdictions",
"description": "Returns a list of Tax Jurisdictions ordered by Tax Region, Parent Tax Jurisdiction, and Jurisdiction.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsTaxJurisdictionsGet",
"parameters": [
{
"name": "Skip",
"in": "query",
"description": "The number of jurisdictions to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Take",
"in": "query",
"description": "The number of jurisdictions to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "TaxRegion",
"in": "query",
"description": "An optional parameter used to restrict the list of jurisdictions to those levied by the specified tax region. \r\nA list of Regions can be found in the Regions Datalist.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "ParentTaxJurisdiction",
"in": "query",
"description": "An optional parameter used to restrict the list of jurisdictions to those of a specific level. \r\nA list of Parent Tax Jurisdictions can be found in the Parent Tax Jurisdictions Datalist.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "IsPaidByEmployee",
"in": "query",
"description": "An optional parameter used to restrict the list of jurisdictions based on whether or not the tax is paid by the employee.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "CountryCode",
"in": "query",
"description": "An optional parameter used to restrict the list of jurisdictions based on the jurisdiction country code.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "CompatibleTaxJurisdiction",
"in": "query",
"description": "An optional parameter used to restrict the list of jurisdictions based on the compatible tax jurisdiction.",
"style": "form",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.TaxJurisdictionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.TaxJurisdictionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.TaxJurisdictionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.TaxJurisdictionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.TaxJurisdictionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.TaxJurisdictionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.TaxJurisdictionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/templateCategories": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Template Categories",
"description": "Returns a list of Template Categories.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsTemplateCategoriesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.TemplateCategoryList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.TemplateCategoryList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.TemplateCategoryList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.TemplateCategoryList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.TemplateCategoryList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.TemplateCategoryList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.TemplateCategoryList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/templateCategories/{templateCategoryId}/templates": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Templates by category",
"description": "Returns a list of templates visible in a TemplateCategory, optionally filtered by type and active status.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsTemplateCategoriesByTemplateCategoryIdTemplatesGet",
"parameters": [
{
"name": "templateCategoryId",
"in": "path",
"description": "The Id of the Template Category to retrieve the templates for. See datalists/templateCategories for a list of valid Template Categories.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "templateTypeId",
"in": "query",
"description": "Optional Id. The Id of the TemplateType to filter by.",
"style": "form",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "isActive",
"in": "query",
"description": "Optional bool. If specified, filters the results by Active status.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.TemplateCategoryTemplatesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.TemplateCategoryTemplatesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.TemplateCategoryTemplatesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.TemplateCategoryTemplatesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.TemplateCategoryTemplatesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.TemplateCategoryTemplatesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.TemplateCategoryTemplatesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/templateCategories/{templateCategoryId}/templateTypes": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Template Types",
"description": "Returns a list of Template Types.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsTemplateCategoriesByTemplateCategoryIdTemplateTypesGet",
"parameters": [
{
"name": "templateCategoryId",
"in": "path",
"description": "The Id of the Template Category for the Template Types to return. See datalists/templateCategories for a list of valid Template Categories.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.TemplateTypeList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.TemplateTypeList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.TemplateTypeList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.TemplateTypeList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.TemplateTypeList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.TemplateTypeList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.TemplateTypeList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/templateDataSources": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Template data sources",
"description": "Returns a list of available template data sources.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsTemplateDataSourcesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.TemplateDataSourcesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.TemplateDataSourcesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.TemplateDataSourcesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.TemplateDataSourcesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.TemplateDataSourcesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.TemplateDataSourcesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.TemplateDataSourcesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/templateDataSources/{templateDataSourceId}/fields": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Template data source fields",
"description": "Returns a list of available fields for a particular template data source.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsTemplateDataSourcesByTemplateDataSourceIdFieldsGet",
"parameters": [
{
"name": "templateDataSourceId",
"in": "path",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"text/csv": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
}
},
"/DataLists/textMessageProviders": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Text Message Providers",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsTextMessageProvidersGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of providers to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of providers to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.TextMessageProviderList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.TextMessageProviderList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.TextMessageProviderList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.TextMessageProviderList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.TextMessageProviderList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.TextMessageProviderList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.TextMessageProviderList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/timeClockTimeZones": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Time Clock Time Zones",
"description": "Returns a list of Time Clock Time Zones ordered by Time Zone Offset.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsTimeClockTimeZonesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of time zones to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of time zones to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "isDaylightSavingsTime",
"in": "query",
"description": "Optional parameter to limit list to only daylight savings time timezones or non daylight savings time timezones. Do not specify to obtain all time zones.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "zipCode",
"in": "query",
"description": "Optional parameter to retrieve the timezone from zip.",
"style": "form",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.TimeClockTimeZoneListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.TimeClockTimeZoneListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.TimeClockTimeZoneListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.TimeClockTimeZoneListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.TimeClockTimeZoneListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.TimeClockTimeZoneListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.TimeClockTimeZoneListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/timeFormats": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Time Formats",
"description": "Returns a list of Time Formats ordered by Time Format Id.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsTimeFormatsGet",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.TimeFormatListQuery.Result"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.TimeFormatListQuery.Result"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.TimeFormatListQuery.Result"
}
}
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.TimeFormatListQuery.Result"
}
}
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.TimeFormatListQuery.Result"
}
}
}
}
}
}
}
},
"/DataLists/timezones": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Timezones",
"description": "Returns a list of Timezones ordered by Timezone Description.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsTimezonesGet",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.TimezoneListQuery.Result"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.TimezoneListQuery.Result"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.TimezoneListQuery.Result"
}
}
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.TimezoneListQuery.Result"
}
}
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.TimezoneListQuery.Result"
}
}
}
}
}
}
}
},
"/DataLists/vendors": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Vendors",
"description": "Returns a list of Vendors visible to the current user.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsVendorsGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of vendors to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of vendors to take. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "name",
"in": "query",
"description": "Optional parameter to limit list to only vendors with the given vendor name or identifier. Will return all vendors if not specified.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "active",
"in": "query",
"description": "Optional parameter to limit list to only active or inactive vendors. Will return all vendors if not specified.",
"style": "form",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.CompanyListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.CompanyListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.CompanyListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.CompanyListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.CompanyListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.CompanyListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.CompanyListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/veteranstatuses": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Veteran Statuses",
"description": "Returns a list of Veteran Statuses ordered by Veteran Status.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsVeteranstatusesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of veteran statuses to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of veteran statuses to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.VeteranStatusListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.VeteranStatusListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.VeteranStatusListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.VeteranStatusListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.VeteranStatusListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.VeteranStatusListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.VeteranStatusListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/washedstatuses": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Washed Statuses",
"description": "Returns a list of Employee Washed Statuses ordered by Washed Status.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsWashedstatusesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of statuses to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of statuses to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.WashedStatusListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.WashedStatusListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.WashedStatusListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.WashedStatusListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.WashedStatusListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.WashedStatusListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.WashedStatusListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/WebTimecards/Adjustments": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Web Timecard Adjustments Datalist",
"description": "Returns a list of Adjustments available for a Web Timecard. The available adjustments are configured in the WebCenter administration area.\n \n```` Allows roles: ServiceRep, WebUserEmployee ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsWebTimecardsAdjustmentsGet",
"parameters": [
{
"name": "assignmentId",
"in": "query",
"description": "The Id of the assignment.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Datalists.EmployeeWebTimecardAdjustmentsForAssignment.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Datalists.EmployeeWebTimecardAdjustmentsForAssignment.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Datalists.EmployeeWebTimecardAdjustmentsForAssignment.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Datalists.EmployeeWebTimecardAdjustmentsForAssignment.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Datalists.EmployeeWebTimecardAdjustmentsForAssignment.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Datalists.EmployeeWebTimecardAdjustmentsForAssignment.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Datalists.EmployeeWebTimecardAdjustmentsForAssignment.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/WebTimecards/CostCenters": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Web Timecard Cost Centers",
"description": "Returns a list of Cost Centers for an Assignment. The cost centers are configured in the WebCenter administration area.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsWebTimecardsCostCentersGet",
"parameters": [
{
"name": "assignmentId",
"in": "query",
"description": "The Id of the assignment.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Datalists.WebTimecardCostCentersForAssignment.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Datalists.WebTimecardCostCentersForAssignment.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Datalists.WebTimecardCostCentersForAssignment.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Datalists.WebTimecardCostCentersForAssignment.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Datalists.WebTimecardCostCentersForAssignment.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Datalists.WebTimecardCostCentersForAssignment.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Datalists.WebTimecardCostCentersForAssignment.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/WebTimecards/PayCodes": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Web Timecard Pay Codes",
"description": "Returns a list of Pay codes for an Assignment. The paycodes list are configured in the WebCenter administration area.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsWebTimecardsPayCodesGet",
"parameters": [
{
"name": "assignmentId",
"in": "query",
"description": "The Id of the assignment.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "weekendDate",
"in": "query",
"description": "If supplied, the property IsPaycodeAlreadyUsed will be true if the pay code has been used for the supplied weekend date.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Datalists.WebTimecardPaycodesForAssignment.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Datalists.WebTimecardPaycodesForAssignment.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Datalists.WebTimecardPaycodesForAssignment.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Datalists.WebTimecardPaycodesForAssignment.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Datalists.WebTimecardPaycodesForAssignment.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Datalists.WebTimecardPaycodesForAssignment.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Datalists.WebTimecardPaycodesForAssignment.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/WebTimecards/Statuses": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Web Timecard Status Datalist",
"description": "Returns a list of Web Timecard Statuses ordered by the web timecard status.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsWebTimecardsStatusesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Datalists.WebTimecardStatusList.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Datalists.WebTimecardStatusList.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Datalists.WebTimecardStatusList.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Datalists.WebTimecardStatusList.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Datalists.WebTimecardStatusList.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Datalists.WebTimecardStatusList.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Datalists.WebTimecardStatusList.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/weekdays": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get week days list.",
"description": "Returns a list of all week days in the database.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsWeekdaysGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "Number of week days to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "Number of week days to take. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.WeekdaysListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.WeekdaysListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.WeekdaysListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.WeekdaysListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.WeekdaysListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.WeekdaysListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.WeekdaysListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/WeekendBills": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Weekend Bills",
"description": "Returns a list of WeekendBills ordered by Weekend Bill. By default, the list is ordered by WeekendBill descending. \r\nUse the orderByAscending parameter to change the order to ascending.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsWeekendBillsGet",
"parameters": [
{
"name": "restrictToOpenWeeks",
"in": "query",
"description": "Optional parameter to limit list to only currently open weeks. If not specified, this will default to false and all open and previously opened weeks will be included.",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "orderByAscending",
"in": "query",
"description": "Optional parameter to order the list by WeekendBill in ascending order. If not specified or set to false, the list will be ordered in descending order.",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.WeekendBillList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.WeekendBillList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.WeekendBillList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.WeekendBillList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.WeekendBillList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.WeekendBillList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.WeekendBillList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/weekendDates": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Weekend Dates",
"description": "Returns a list of unique WeekendDate values\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsWeekendDatesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of records to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.WeekendDateList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.WeekendDateList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.WeekendDateList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.WeekendDateList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.WeekendDateList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.WeekendDateList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.WeekendDateList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/workerCompCodes": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Worker Comp Codes",
"description": "Returns a list of all Worker Comp Codes visible to the current user.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsWorkerCompCodesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "Number of worker comp codes to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "Number of worker comp codes to take. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "filter",
"in": "query",
"description": "Filter by worker comp code.",
"style": "form",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.WorkerCompCodeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.WorkerCompCodeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.WorkerCompCodeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.WorkerCompCodeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.WorkerCompCodeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.WorkerCompCodeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.WorkerCompCodeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/workerCompCodes/{workerCompCodeId}": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Worker Comp Code",
"description": "Returns a worker comp code by specified Id.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsWorkerCompCodesByWorkerCompCodeIdGet",
"parameters": [
{
"name": "workerCompCodeId",
"in": "path",
"description": "The worker comp code id to get information about.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.WorkerCompCodeListQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.WorkerCompCodeListQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.WorkerCompCodeListQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.WorkerCompCodeListQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.WorkerCompCodeListQuery.Result"
}
}
}
},
"404": {
"description": "Not Found"
}
}
}
},
"/DataLists/wotcEligibilityStatuses": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get WOTC Eligibility Status List",
"description": "Returns a list of all WOTC Eligibility Statuses.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "DataListsWotcEligibilityStatusesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "Number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "Number of items to take. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.WotcEligibilityStatusList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.WotcEligibilityStatusList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.WotcEligibilityStatusList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.WotcEligibilityStatusList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.WotcEligibilityStatusList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.WotcEligibilityStatusList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.WotcEligibilityStatusList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/DataLists/YearEndTaxFormTypes": {
"get": {
"tags": [
"DataLists"
],
"summary": "Get Year End Tax Form Types",
"description": "Returns a list of Year End Tax Form Types ordered by TaxFormTypeName\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): yearend-read ````",
"operationId": "DataListsYearEndTaxFormTypesGet",
"parameters": [
{
"name": "IsEmployeeRelevant",
"in": "query",
"description": "Optional parameter to limit the list to only those tax forms which are sent to the employee.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.YearEnd.Service.Commands.YearEndTaxFormTypes.Result, YearEnd.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.YearEnd.Service.Commands.YearEndTaxFormTypes.Result, YearEnd.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.YearEnd.Service.Commands.YearEndTaxFormTypes.Result, YearEnd.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.YearEnd.Service.Commands.YearEndTaxFormTypes.Result, YearEnd.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.YearEnd.Service.Commands.YearEndTaxFormTypes.Result, YearEnd.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.YearEnd.Service.Commands.YearEndTaxFormTypes.Result, YearEnd.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.YearEnd.Service.Commands.YearEndTaxFormTypes.Result, YearEnd.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Email": {
"post": {
"tags": [
"Email"
],
"summary": "Send an Email",
"description": " Creates an Email with attachments and stages for sending to the recipients. This requires a multipart form-data POST request. \r\n One part must have the name = \"emailRequest\" and other parts are the attachments. \r\n \r\n For more information about using formdata, see: https://developer.mozilla.org/en-US/docs/Web/API/FormData/FormData\r\n For more information about using multipart/form-data, see: http://stackoverflow.com/questions/4526273/what-does-enctype-multipart-form-data-mean\r\n Below is an example multipart/form-data POST request body for email creation:\r\n \r\n ------WebKitFormBoundarynI6DnTBbjAFxI1Cn\r\n Content-Disposition: form-data; name=\"file\"; filename=\"Test.txt\"\r\n Content-Type: text/plain\r\n \r\n This is where the file content is placed!\r\n ------WebKitFormBoundarynI6DnTBbjAFxI1Cn\r\n Content-Disposition: form-data; name=\"file2\"; filename=\"Test2.txt\"\r\n Content-Type: text/plain\r\n \r\n This is where the file 2 content is placed!\r\n ------WebKitFormBoundarynI6DnTBbjAFxI1Cn\r\n Content-Disposition: form-data; name=\"emailRequest\"\r\n\r\n{\r\n \"emailAccountId\": 12,\r\n \"to\": [\r\n {\r\n \"originType\": 1,\r\n \"originId\": 993783,\r\n \"name\": \"John Allison\",\r\n \"address\": \"notvalid@domain\"\r\n }\r\n ],\r\n \"cc\": [\r\n {\r\n \"originType\": 3,\r\n \"originId\": 2342342234,\r\n \"name\": \"Tom Harrison\",\r\n \"address\": \"ccthisemail@domain\"\r\n }\r\n ],\r\n \"bcc\": [\r\n {\r\n \"originType\": 1,\r\n \"originId\": 345345,\r\n \"name\": \"Alex Newman\",\r\n \"address\": \"bccthisemail@domain\"\r\n }\r\n ],\r\n \"subject\": \"Position Available\",\r\n \"body\": \"Are you interested in the job?\",\r\n \"format\": 0,\r\n \"importance\": 1,\r\n \"sensitivity\": 2,\r\n \"isTemplate\": false,\r\n \"templateId\": \"1EA70012-F63A-4E49-893A-CE5E4603F95C\",\r\n \"logMessage\": true,\r\n \"messageActionId\":8,\r\n \"linkedEntities\":[\r\n { \r\n \"originTypeId\": 1,\r\n \"originId\": 12 \r\n },\r\n { \r\n \"originTypeId\": 3,\r\n \"originId\": 56 \r\n }\r\n ],\r\n \"correlationId\":null\r\n }\r\n \r\n ------WebKitFormBoundarynI6DnTBbjAFxI1Cn--\r\n \r\n \r\n Additional Information regarding emailRequest properties:\r\n \r\n Properties: \r\n \r\n EmailAccountId: (int) The Id of the Email Account.\r\n LogMessage: (bool) When True, a message will be logged on the recipients and linked entities of the email.\r\n Format: (int) Format of the Message. Valid values are 0 - Plain Text or 2 - HTML.\r\n Importance: (int) The email importance. Valid values are 0 - Low, 1 - Normal, and 2 - High. Defaults to Normal.\r\n Sensitivity: (int) The email sensitivity. Optional setting to set the custom Sensitivity Header for MS Exchange Emails. Valid values are 0 - Normal, 1 - Personal, 2 - Private, and 3 - Confidential.\r\n SendSeparateEmails: (bool) When true, all recipients in the To: will get a separate email. All individuals in Cc will be copied and shown the email message.\r\n Example-- To: a@tempworks.com, b@tempworks.com Cc: g@tempworks.com with create 2 emails and both emails will have g@tempworks.com as the Cc.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): email-write ````",
"operationId": "EmailPost",
"responses": {
"202": {
"description": "The email has been created and staged to be sent to the recipients.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Email.Service.Commands.OrchestrateCreateEmail.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Email.Service.Commands.OrchestrateCreateEmail.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Email.Service.Commands.OrchestrateCreateEmail.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Email.Service.Commands.OrchestrateCreateEmail.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Email.Service.Commands.OrchestrateCreateEmail.Result"
}
}
}
},
"400": {
"description": "The request is invalid."
}
}
},
"get": {
"tags": [
"Email"
],
"summary": "Get a list of email batches sent by the current user.",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): email-read ````",
"operationId": "EmailGet",
"parameters": [
{
"name": "IncludeOnlyBatchesWithFailures",
"in": "query",
"description": "If true, the response will only include email batches where one or more emails have failed or partially failed.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "Skip",
"in": "query",
"description": "Number of list items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Take",
"in": "query",
"description": "Number of list items to take. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "StartDate",
"in": "query",
"description": "If provided, then the results will be limited to email batches sent after this date.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "EndDate",
"in": "query",
"description": "If provided, then the results will be limited to email batches sent before this date.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Email.Service.Commands.SentEmailBatches.Result, Email.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Email.Service.Commands.SentEmailBatches.Result, Email.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Email.Service.Commands.SentEmailBatches.Result, Email.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Email.Service.Commands.SentEmailBatches.Result, Email.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Email.Service.Commands.SentEmailBatches.Result, Email.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Email.Service.Commands.SentEmailBatches.Result, Email.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Email.Service.Commands.SentEmailBatches.Result, Email.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Email/{correlationId}": {
"get": {
"tags": [
"Email"
],
"summary": "Get Email Batch Emails",
"description": "Returns a list of Email Batch Emails.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): email-read ````",
"operationId": "EmailByCorrelationIdGet",
"parameters": [
{
"name": "correlationId",
"in": "path",
"description": "Id for a batch of related emails.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "emailSessionStatusId",
"in": "query",
"description": "An optional parameter identifies the status of the email session. Valid values are '0' queued, '1' sent, '2' error, '3' partial error.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "skip",
"in": "query",
"description": "Number of records to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "Number of records to take. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Email.Service.Commands.GetEmailBatchEmails.Result, Email.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Email.Service.Commands.GetEmailBatchEmails.Result, Email.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Email.Service.Commands.GetEmailBatchEmails.Result, Email.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Email.Service.Commands.GetEmailBatchEmails.Result, Email.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Email.Service.Commands.GetEmailBatchEmails.Result, Email.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Email.Service.Commands.GetEmailBatchEmails.Result, Email.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Email.Service.Commands.GetEmailBatchEmails.Result, Email.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Email/emailAccount/autodiscover": {
"post": {
"tags": [
"Email"
],
"summary": "Auto discover smtp settings based on user email and password",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "EmailEmailAccountAutodiscoverPost",
"requestBody": {
"description": "The details of the Smtp Credentials to test.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Email.SmtpAutoDiscoverRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Email.SmtpAutoDiscoverRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Email.SmtpAutoDiscoverRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Email.SmtpAutoDiscoverRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Email.SmtpAutoDiscoverRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Email.SmtpAutoDiscoverRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Email.SmtpAutoDiscoverRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Email.SmtpAutoDiscoverRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Email.Service.Commands.SmtpAutoDiscover.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Email.Service.Commands.SmtpAutoDiscover.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Email.Service.Commands.SmtpAutoDiscover.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Email.Service.Commands.SmtpAutoDiscover.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Email.Service.Commands.SmtpAutoDiscover.Result"
}
}
}
}
}
}
},
"/Email/emailAccount/diag": {
"post": {
"tags": [
"Email"
],
"summary": "Get Diagnostic Information for smtp account",
"description": "Returns detailed diagnostic info for the email using the provided smtp credentials.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "EmailEmailAccountDiagPost",
"requestBody": {
"description": "The details of the Smtp Credentials to test.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Email.SmtpSettingsRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Email.SmtpSettingsRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Email.SmtpSettingsRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Email.SmtpSettingsRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Email.SmtpSettingsRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Email.SmtpSettingsRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Email.SmtpSettingsRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Email.SmtpSettingsRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Email.Service.Commands.TestSmtpCredentials.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Email.Service.Commands.TestSmtpCredentials.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Email.Service.Commands.TestSmtpCredentials.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Email.Service.Commands.TestSmtpCredentials.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Email.Service.Commands.TestSmtpCredentials.Result"
}
}
}
}
}
}
},
"/Email/sendTestEmail": {
"post": {
"tags": [
"Email"
],
"summary": "Send a Test Email.",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): email-write ````",
"operationId": "EmailSendTestEmailPost",
"requestBody": {
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Email.API.Models.CreateTestEmailRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Email.API.Models.CreateTestEmailRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Email.API.Models.CreateTestEmailRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Email.API.Models.CreateTestEmailRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Email.API.Models.CreateTestEmailRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Email.API.Models.CreateTestEmailRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Email.API.Models.CreateTestEmailRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Email.API.Models.CreateTestEmailRequest"
}
}
}
},
"responses": {
"202": {
"description": "The email has been created and staged to be sent to the recipients.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Email.Service.Commands.SendTestEmail.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Email.Service.Commands.SendTestEmail.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Email.Service.Commands.SendTestEmail.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Email.Service.Commands.SendTestEmail.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Email.Service.Commands.SendTestEmail.Result"
}
}
}
},
"400": {
"description": "The request is invalid."
}
}
}
},
"/Employees": {
"post": {
"tags": [
"Employees"
],
"summary": "Create Employee",
"description": "Creates a new employee.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesPost",
"requestBody": {
"description": "A model containing the information with which to create the new employee",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeRequest"
}
}
}
},
"responses": {
"201": {
"description": "Id of the new employee",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.OrchestrateCreateEmployeeCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.OrchestrateCreateEmployeeCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.OrchestrateCreateEmployeeCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.OrchestrateCreateEmployeeCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.OrchestrateCreateEmployeeCommand.Result"
}
}
}
}
}
}
},
"/Employees/{employeeId}/AuthenticationData": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Authentication Data record for a specified employee.",
"description": "Get Authentication Data for an employee to use to access an On-Site Time Clock.\r\nThe Authentication Data returned may be a collection if the AuthMethodDataId is not specified.\r\nIf the AuthMethodDataId is specified then only that Authentication Data will be returned.\n \n```` Allows roles: ServiceRep, Service, WebUserEmployee ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByEmployeeIdAuthenticationDataGet",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "Employee Id used to get authentication data for.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "authMethodDataId",
"in": "query",
"description": "Employee Authentication Method Data Id used to get the specific Authentication Data.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Timeclock.OnSiteTimeClockAuthDataQuery.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Timeclock.OnSiteTimeClockAuthDataQuery.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Timeclock.OnSiteTimeClockAuthDataQuery.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Timeclock.OnSiteTimeClockAuthDataQuery.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Timeclock.OnSiteTimeClockAuthDataQuery.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Timeclock.OnSiteTimeClockAuthDataQuery.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Timeclock.OnSiteTimeClockAuthDataQuery.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Employees/{employeeId}/avatar": {
"delete": {
"tags": [
"Employees"
],
"summary": "Deletes Employee Avatar",
"description": "Deletes the employee's avatar file content for the specified employee.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByEmployeeIdAvatarDelete",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{employeeId}/avatar/bytes": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Employee Avatar",
"description": "Gets the employee's avatar file content for the specified employee.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByEmployeeIdAvatarBytesGet",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "string",
"format": "byte"
}
},
"text/csv": {
"schema": {
"type": "string",
"format": "byte"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"type": "string",
"format": "byte"
}
},
"application/json": {
"schema": {
"type": "string",
"format": "byte"
}
},
"text/json": {
"schema": {
"type": "string",
"format": "byte"
}
},
"application/xml": {
"schema": {
"type": "string",
"format": "byte"
}
},
"text/xml": {
"schema": {
"type": "string",
"format": "byte"
}
}
}
}
}
},
"put": {
"tags": [
"Employees"
],
"summary": "Create or Update Employee Avatar",
"description": "Create or Update the employee's avatar file content for the specified employee.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByEmployeeIdAvatarBytesPut",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"201": {
"description": "Created"
}
}
}
},
"/Employees/{employeeId}/Branch": {
"put": {
"tags": [
"Employees"
],
"summary": "Updates Employee to a target branch and hierarchy",
"description": "Updates Employee to a target branch and hierarchy if the validation is successful.\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByEmployeeIdBranchPut",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "Request object for updating employee's branch and hierarchy.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeBranchHierarchyRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeBranchHierarchyRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeBranchHierarchyRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeBranchHierarchyRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeBranchHierarchyRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeBranchHierarchyRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeBranchHierarchyRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeBranchHierarchyRequest"
}
}
}
},
"responses": {
"204": {
"description": "Validation passes with no errors and the employee is updated to a branch in the same company."
},
"201": {
"description": "Validation passes with no errors and a new copy of the employee is created in the target branch which is in a different company.",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int64"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int64"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int64"
}
},
"application/xml": {
"schema": {
"type": "integer",
"format": "int64"
}
},
"text/xml": {
"schema": {
"type": "integer",
"format": "int64"
}
}
}
},
"400": {
"description": "Invalid Request."
},
"403": {
"description": "Api user has no permission to update employee branch and hierarchy. Or the branch's hier is not configured."
},
"404": {
"description": "An item referenced is not found (employee, branch)."
},
"409": {
"description": "Employee's SSN already exists in the target company."
}
}
}
},
"/Employees/{employeeId}/Branch/validate": {
"put": {
"tags": [
"Employees"
],
"summary": "Check the update employee's branch and hierarchy validations.",
"description": "Returns validation messages regarding the update employee branch and hierarchy request. \r\nThis includes errors regarding duplicate SSN, assignment status, permissions.\r\nA HttpStatus code 400 will be returned if there is an invalid entry in the request.\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByEmployeeIdBranchValidatePut",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "Request object for updating employee's branch and hierarchy.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeBranchHierarchyRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeBranchHierarchyRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeBranchHierarchyRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeBranchHierarchyRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeBranchHierarchyRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeBranchHierarchyRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeBranchHierarchyRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeBranchHierarchyRequest"
}
}
}
},
"responses": {
"200": {
"description": "Validation passes with no errors."
},
"400": {
"description": "Invalid Request."
},
"403": {
"description": "Api user has no permission to update employee branch and hierarchy. Or the branch's hier is not configured."
},
"404": {
"description": "An item referenced is not found (employee, branch)."
},
"409": {
"description": "Employee's SSN already exists in the target company."
}
}
}
},
"/Employees/{employeeId}/Merge": {
"post": {
"tags": [
"Employees"
],
"summary": "Merges data from a source Employee to a target Employee",
"description": "Merges one employee's details and data to another employee's existing data.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByEmployeeIdMergePost",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "Id of source employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "Request object for merging into target employee.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.MergeEmployeeRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.MergeEmployeeRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.MergeEmployeeRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.MergeEmployeeRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.MergeEmployeeRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.MergeEmployeeRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.MergeEmployeeRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.MergeEmployeeRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{employeeId}/messages/{messageId}": {
"put": {
"tags": [
"Employees"
],
"summary": "Update Message",
"description": "Updates a message and links it to the employee.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByEmployeeIdMessagesByMessageIdPut",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "messageId",
"in": "path",
"description": "The Id of the message",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The body of the request containing the information required to update the message.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.UpdateMessageWithLinkedDocumentsRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.UpdateMessageWithLinkedDocumentsRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.UpdateMessageWithLinkedDocumentsRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.UpdateMessageWithLinkedDocumentsRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.UpdateMessageWithLinkedDocumentsRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.UpdateMessageWithLinkedDocumentsRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.UpdateMessageWithLinkedDocumentsRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.UpdateMessageWithLinkedDocumentsRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.UpdateContactMessageResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.UpdateContactMessageResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.UpdateContactMessageResult"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.UpdateContactMessageResult"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.UpdateContactMessageResult"
}
}
}
}
}
}
},
"/Employees/{employeeId}/messages/{messageId}/documents": {
"post": {
"tags": [
"Employees"
],
"summary": "Upload document to a message",
"description": "\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByEmployeeIdMessagesByMessageIdDocumentsPost",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "messageId",
"in": "path",
"description": "The Id of the message.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"required": [
"DocumentName",
"DocumentTypeId"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
},
"DocumentName": {
"type": "string"
},
"DocumentTypeId": {
"type": "integer",
"format": "int32"
},
"Description": {
"maxLength": 255,
"type": "string"
},
"ExpirationDate": {
"type": "string",
"format": "date-time"
},
"Version": {
"type": "string"
}
}
},
"encoding": {
"File": {
"style": "form"
},
"DocumentName": {
"style": "form"
},
"DocumentTypeId": {
"style": "form"
},
"Description": {
"style": "form"
},
"ExpirationDate": {
"style": "form"
},
"Version": {
"style": "form"
}
}
}
}
},
"responses": {
"201": {
"description": "Id of the new document.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
}
}
}
}
}
},
"/Employees/{employeeId}/Metadata": {
"get": {
"tags": [
"Employees"
],
"summary": "Check for employee metadata",
"description": "Shows whether employee has assignments or pay history, contact methods, custom data values, documents, education, interest codes, interviews, logged messages, or work history / references.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByEmployeeIdMetadataGet",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Queries.GetEmployeeMetadata.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Queries.GetEmployeeMetadata.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Queries.GetEmployeeMetadata.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Queries.GetEmployeeMetadata.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Queries.GetEmployeeMetadata.Result"
}
}
}
}
}
}
},
"/Employees/{employeeId}/Onboarding/PaySetup": {
"put": {
"tags": [
"Enrollment"
],
"summary": "Enrolls an employee's pay setup during onboarding, configuring direct deposit or live check preferences.",
"description": "\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByEmployeeIdOnboardingPaySetupPut",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The unique identifier of the employee being enrolled.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The pay setup enrollment request containing payment method preferences. When `PayByDirectDeposit` is\r\n`true`, primary and optional secondary direct deposit account details must be provided.\r\nWhen `false`, the employee is enrolled for live check and banking fields should be omitted.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.EnrollmentEmployeePaySetupRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.EnrollmentEmployeePaySetupRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.EnrollmentEmployeePaySetupRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.EnrollmentEmployeePaySetupRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.EnrollmentEmployeePaySetupRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.EnrollmentEmployeePaySetupRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.EnrollmentEmployeePaySetupRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.EnrollmentEmployeePaySetupRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{employeeId}/Onboarding/TaxForm/Federal/W4/Year/2025": {
"post": {
"tags": [
"Enrollment"
],
"summary": "Submit Federal W-4 – 2025 revision.",
"description": "Submits a Federal W-4 for the specified employee using the IRS form labeled as the 2025 revision.\r\nYear/2025 in the route denotes the form’s revision year.\r\n \r\nValidation includes:\r\n- Data annotations on the request model (required fields, string lengths, formats).\r\n- Domain rules such as exactly one filing status selection and valid state codes.\r\n- Monetary fields must be non-negative and respect decimal precision.\r\n \r\nBehavior highlights:\r\n- When Step4IsExempt is true, extra withholding is set to 0 and exemptions are handled accordingly.\r\n- Filing status determines the marital tax status used by downstream calculations.\r\n- If the submitted state matches the employee's last known state W-4, federal-only recalculations may be performed.\r\n \r\nRoute: POST /Employees/{employeeId}/Onboarding/TaxForm/Federal/W4/Year/2025\r\nAuthorization: EMPLOYEETAXFORM_WRITE (Service, ServiceRep)\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employeetaxform-write ````",
"operationId": "EmployeesByEmployeeIdOnboardingTaxFormFederalW4Year2025Post",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The employee identifier.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The Federal W-4 (2025 revision) payload for the employee.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.FederalW4TaxForm2025Model"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.FederalW4TaxForm2025Model"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.FederalW4TaxForm2025Model"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.FederalW4TaxForm2025Model"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.FederalW4TaxForm2025Model"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.FederalW4TaxForm2025Model"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.FederalW4TaxForm2025Model"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.FederalW4TaxForm2025Model"
}
}
}
},
"responses": {
"204": {
"description": "The W-4 was accepted and processed."
},
"400": {
"description": "The request was invalid; see validation errors for details."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden – the caller lacks required permissions."
},
"404": {
"description": "The employee was not found or is not visible to the caller."
}
},
"deprecated": true
}
},
"/Employees/{employeeId}/Onboarding/TaxForm/Federal/W4/Year/2026": {
"post": {
"tags": [
"Enrollment"
],
"summary": "Submit Federal W-4 – 2026 revision.",
"description": "Submits a Federal W-4 for the specified employee using the IRS form labeled as the 2026 revision.\r\nYear/2026 in the route denotes the form’s revision year.\r\n \r\nValidation includes:\r\n- Data annotations on the request model (required fields, string lengths, formats).\r\n- Domain rules such as exactly one filing status selection and valid state codes.\r\n- Monetary fields must be non-negative and respect decimal precision.\r\n \r\nBehavior highlights:\r\n- When Step4IsExempt is true, extra withholding is set to 0 and exemptions are handled accordingly.\r\n- Filing status determines the marital tax status used by downstream calculations.\r\n- If the submitted state matches the employee's last known state W-4, federal-only recalculations may be performed.\r\n \r\nRoute: POST /Employees/{employeeId}/Onboarding/TaxForm/Federal/W4/Year/2026\r\nAuthorization: EMPLOYEETAXFORM_WRITE (Service, ServiceRep)\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employeetaxform-write ````",
"operationId": "EmployeesByEmployeeIdOnboardingTaxFormFederalW4Year2026Post",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The employee identifier.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The Federal W-4 (2026 revision) payload for the employee.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.FederalW4TaxForm2026Model"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.FederalW4TaxForm2026Model"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.FederalW4TaxForm2026Model"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.FederalW4TaxForm2026Model"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.FederalW4TaxForm2026Model"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.FederalW4TaxForm2026Model"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.FederalW4TaxForm2026Model"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.FederalW4TaxForm2026Model"
}
}
}
},
"responses": {
"204": {
"description": "The W-4 was accepted and processed."
},
"400": {
"description": "The request was invalid; see validation errors for details."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden – the caller lacks required permissions."
},
"404": {
"description": "The employee was not found or is not visible to the caller."
}
}
}
},
"/Employees/{employeeId}/Onboarding/TaxForm/State/Alabama/A4/Year/2025": {
"post": {
"tags": [
"Enrollment"
],
"summary": "Submit Alabama A-4 (state withholding) – 2025 revision.",
"description": "Submits an Alabama A-4 (state withholding) form for the specified employee for the 2025 form revision.\r\nYear/2025 in the route denotes the form’s revision year.\r\n \r\nThe request is validated using data annotations and domain rules. Key validations include:\r\n- Required employee demographic fields and SSN format (xxx-xx-xxxx).\r\n- Alabama filing status selection and dependents range.\r\n- Additional withholding amounts must be non-negative and use two decimal places.\r\n \r\nBehavior highlights:\r\n- Filing status is mapped to the appropriate jurisdiction for Alabama.\r\n- Dependents and additional withholding amounts are used to update employee tax setup.\r\n \r\nRoute: POST /Employees/{employeeId}/Onboarding/TaxForm/State/Alabama/A4/Year/2025\r\nAuthorization: EMPLOYEETAXFORM_WRITE (Service, ServiceRep)\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employeetaxform-write ````",
"operationId": "EmployeesByEmployeeIdOnboardingTaxFormStateAlabamaA4Year2025Post",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The employee identifier.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The Alabama A-4 (2025 revision) payload for the employee.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.AlabamaA4TaxForm2025Model"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.AlabamaA4TaxForm2025Model"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.AlabamaA4TaxForm2025Model"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.AlabamaA4TaxForm2025Model"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.AlabamaA4TaxForm2025Model"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.AlabamaA4TaxForm2025Model"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.AlabamaA4TaxForm2025Model"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.AlabamaA4TaxForm2025Model"
}
}
}
},
"responses": {
"204": {
"description": "The A-4 was accepted and processed."
},
"400": {
"description": "The request was invalid; see validation errors for details."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden – the caller lacks required permissions."
},
"404": {
"description": "The employee was not found or is not visible to the caller."
}
}
}
},
"/Employees/{employeeId}/Onboarding/TaxForm/State/Arizona/A4/Year/2025": {
"post": {
"tags": [
"Enrollment"
],
"summary": "Submit Arizona A-4 (state withholding) – 2025 revision.",
"description": "Submits an Arizona A-4 (state withholding) form for the specified employee for the 2025 form revision.\r\nYear/2025 in the route denotes the form’s revision year.\r\n\r\nThe request is validated using data annotations and domain rules. Key validations include:\r\n- Required employee demographic fields and SSN format (xxx-xx-xxxx).\r\n- Exactly one of Box1 or Box2 must be selected.\r\n- When Box1 is selected, `Box1Rate` must be one of: 0.5, 1.0, 1.5, 2.0, 2.5, 3.0, 3.5 (one decimal place).\r\n- When Box1 and `Box1AdditionalWithholding` are selected, a positive `Box1AdditionalWithholdingAmount` is required (two decimals).\r\n- When Box2 is selected, `Box1AdditionalWithholding` must be false, `Box1Rate` must not be provided, and `Box1AdditionalWithholdingAmount` must be 0 or omitted.\r\n \r\nBehavior highlights:\r\n- The request model is mapped directly to a service model and dispatched to the Arizona W-4 command via MediatR.\r\n- Domain validation is enforced in the Arizona mapping sub-command.\r\n- On success, this endpoint returns 204 No Content.\r\n \r\nRoute: POST /Employees/{employeeId}/Onboarding/TaxForm/State/Arizona/A4/Year/2025\r\nAuthorization: EMPLOYEETAXFORM_WRITE (Service, ServiceRep)\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employeetaxform-write ````",
"operationId": "EmployeesByEmployeeIdOnboardingTaxFormStateArizonaA4Year2025Post",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The employee identifier.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The Arizona state A-4 (2025 revision) payload for the employee.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ArizonaA4TaxForm2025Model"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ArizonaA4TaxForm2025Model"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ArizonaA4TaxForm2025Model"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ArizonaA4TaxForm2025Model"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ArizonaA4TaxForm2025Model"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ArizonaA4TaxForm2025Model"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ArizonaA4TaxForm2025Model"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ArizonaA4TaxForm2025Model"
}
}
}
},
"responses": {
"204": {
"description": "The A-4 was accepted and processed."
},
"400": {
"description": "The request was invalid; see validation errors for details."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden – the caller lacks required permissions."
},
"404": {
"description": "The employee was not found or is not visible to the caller."
}
},
"deprecated": true
}
},
"/Employees/{employeeId}/Onboarding/TaxForm/State/Arizona/A4/Year/2026": {
"post": {
"tags": [
"Enrollment"
],
"summary": "Submit Arizona A-4 (state withholding) – 2026 revision.",
"description": "Submits an Arizona A-4 (state withholding) form for the specified employee for the 2026 form revision.\r\nYear/2026 in the route denotes the form's revision year.\r\n\r\nThe request is validated using data annotations and domain rules. Key validations include:\r\n- Required employee demographic fields and SSN format (xxx-xx-xxxx).\r\n- Exactly one of Box1 or Box2 must be selected.\r\n- When Box1 is selected, `Box1Rate` must be one of: 0.5, 1.0, 1.5, 2.0, 2.5, 3.0, 3.5 (one decimal place).\r\n- When Box1 and `Box1AdditionalWithholding` are selected, a positive `Box1AdditionalWithholdingAmount` is required (two decimals).\r\n- When Box2 is selected, `Box1AdditionalWithholding` must be false, `Box1Rate` must not be provided, and `Box1AdditionalWithholdingAmount` must be 0 or omitted.\r\n \r\nBehavior highlights:\r\n- The request model is mapped directly to a service model and dispatched to the Arizona W-4 command via MediatR.\r\n- Domain validation is enforced in the Arizona mapping sub-command.\r\n- On success, this endpoint returns 204 No Content.\r\n \r\nRoute: POST /Employees/{employeeId}/Onboarding/TaxForm/State/Arizona/A4/Year/2026\r\nAuthorization: EMPLOYEETAXFORM_WRITE (Service, ServiceRep)\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employeetaxform-write ````",
"operationId": "EmployeesByEmployeeIdOnboardingTaxFormStateArizonaA4Year2026Post",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The employee identifier.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The Arizona state A-4 (2026 revision) payload for the employee.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ArizonaA4TaxForm2026Model"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ArizonaA4TaxForm2026Model"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ArizonaA4TaxForm2026Model"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ArizonaA4TaxForm2026Model"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ArizonaA4TaxForm2026Model"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ArizonaA4TaxForm2026Model"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ArizonaA4TaxForm2026Model"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ArizonaA4TaxForm2026Model"
}
}
}
},
"responses": {
"204": {
"description": "The A-4 was accepted and processed."
},
"400": {
"description": "The request was invalid; see validation errors for details."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden – the caller lacks required permissions."
},
"404": {
"description": "The employee was not found or is not visible to the caller."
}
}
}
},
"/Employees/{employeeId}/Onboarding/TaxForm/State/Arkansas/AR4EC/Year/2025": {
"post": {
"tags": [
"Enrollment"
],
"summary": "Submit Arkansas AR4EC (state withholding) – 2025 revision.",
"description": "Submits an Arkansas AR4EC (state withholding) form for the specified employee for the 2025 form revision.\r\nYear/2025 in the route denotes the form’s revision year.\r\n\r\nThe request is validated using data annotations and domain rules. Key validations include:\r\n- One and only one of SingleDependent, MarriedDependent, or HOHDependent must be true\r\n- SingleDependentExemptionClaim must be 1 or 0\r\n- MarriedDependentExemptionClaim must be 2 or 0 \r\n- HeadOfHouseholdDependentExemptionClaim must be 2 or 0 \r\n- One and only one of SingleDependent, MarriedDependent, or HOHDependent must be true\r\n- Number of Children or Dependent Amount must be less that 100\r\n- Total Exemption Amount must be less that 100\r\n- Additional Witholding Amount must be less that 10000\r\n- One LowIncome or Regular Tax Filing status box must be true\r\n- One Filing status box must be true if LowIncome was selected\r\n- One and only one of LowIncomeSingleFilingStatus, LowIncomeMarriedFilingStatus, or Box4HeadOfHouseholdStatus must be true\r\n \r\nBehavior highlights:\r\n- The request model is mapped directly to a service model and dispatched to the Arkansas W-4 command via MediatR.\r\n- Domain validation is enforced in the Arkansas mapping sub-command.\r\n \r\nRoute: POST /Employees/{employeeId}/onboarding/State/Arkansas/AR4EC/Year/2025\r\nAuthorization: EMPLOYEETAXFORM_WRITE (Service, ServiceRep)\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employeetaxform-write ````",
"operationId": "EmployeesByEmployeeIdOnboardingTaxFormStateArkansasAR4ECYear2025Post",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The employee identifier.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The Arkansas state AR4EC (2025 revision) payload for the employee.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ArkansasAR4ECTaxForm2025Model"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ArkansasAR4ECTaxForm2025Model"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ArkansasAR4ECTaxForm2025Model"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ArkansasAR4ECTaxForm2025Model"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ArkansasAR4ECTaxForm2025Model"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ArkansasAR4ECTaxForm2025Model"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ArkansasAR4ECTaxForm2025Model"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ArkansasAR4ECTaxForm2025Model"
}
}
}
},
"responses": {
"204": {
"description": "A success message indicating the AR4EC was accepted and processed."
},
"400": {
"description": "The request was invalid; see validation errors for details."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden – the caller lacks required permissions."
},
"404": {
"description": "The employee was not found or is not visible to the caller."
}
},
"deprecated": true
}
},
"/Employees/{employeeId}/Onboarding/TaxForm/State/Arkansas/AR4EC/Year/2026": {
"post": {
"tags": [
"Enrollment"
],
"summary": "Submit Arkansas AR4EC (state withholding) – 2026 revision.",
"description": "Submits an Arkansas AR4EC (state withholding) form for the specified employee for the 2026 form revision (R 12/04/2025).\r\nYear/2026 in the route denotes the form's revision year.\r\n \r\nThe request is validated using data annotations and domain rules. Key validations include:\r\n- Exactly one of SingleExemptionClaimed, MarriedExemptionClaimed, or HeadOfHouseholdExemptionClaimed must be true\r\n- SingleExemptionCount must be 1 when SingleExemptionClaimed is true, else 0\r\n- MarriedExemptionCount must be 2 when MarriedExemptionClaimed is true, else 0\r\n- HeadOfHouseholdExemptionCount must be 2 when HeadOfHouseholdExemptionClaimed is true, else 0\r\n- TotalExemptions must equal SingleExemptionCount + MarriedExemptionCount + HeadOfHouseholdExemptionCount + Dependents\r\n- AdditionalWithholdingAmount cannot be 10000 or greater\r\n- Exactly one of LowIncomeSingleFilingStatus, LowIncomeMarriedFilingStatus, or LowIncomeHeadOfHouseholdStatus must be true when LowIncomeQualifies is true\r\n- All filing status boxes must be false when LowIncomeQualifies is false\r\n \r\nBehavior highlights:\r\n- The request model is mapped directly to a service model and dispatched to the Arkansas AR4EC command via MediatR.\r\n- Domain validation is enforced in the Arkansas 2026 mapping sub-command.\r\n \r\nRoute: POST /Employees/{employeeId}/onboarding/State/Arkansas/AR4EC/Year/2026\r\nAuthorization: EMPLOYEETAXFORM_WRITE (Service, ServiceRep)\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employeetaxform-write ````",
"operationId": "EmployeesByEmployeeIdOnboardingTaxFormStateArkansasAR4ECYear2026Post",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The employee identifier.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The Arkansas state AR4EC (2026 revision) payload for the employee.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ArkansasAR4ECTaxForm2026Model"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ArkansasAR4ECTaxForm2026Model"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ArkansasAR4ECTaxForm2026Model"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ArkansasAR4ECTaxForm2026Model"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ArkansasAR4ECTaxForm2026Model"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ArkansasAR4ECTaxForm2026Model"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ArkansasAR4ECTaxForm2026Model"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ArkansasAR4ECTaxForm2026Model"
}
}
}
},
"responses": {
"204": {
"description": "A success message indicating the AR4EC was accepted and processed."
},
"400": {
"description": "The request was invalid; see validation errors for details."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden – the caller lacks required permissions."
},
"404": {
"description": "The employee was not found or is not visible to the caller."
}
}
}
},
"/Employees/{employeeId}/Onboarding/TaxForm/State/California/DE4/Year/2025": {
"post": {
"tags": [
"Enrollment"
],
"summary": "Submit California DE 4 (state withholding) – 2025 revision.",
"description": "Submits a California DE 4 (state withholding) form for the specified employee for the 2025 form revision.\r\nYear/2025 in the route denotes the form’s revision year.\r\n \r\nThe request is validated using data annotations and domain rules. Key validations include:\r\n- Required employee demographic fields and SSN format (xxx-xx-xxxx).\r\n- Region must be a valid 2-letter US state code; the handler treats this as California-specific logic.\r\n- Filing status: exactly one of `SingleOrMarriedTwoIncome`, `MarriedOneIncome`, or `HeadOfHousehold` must be selected.\r\n- Exempt/allowances rules:\r\n - If both `Step3Exempt` and `Step4Exempt` are selected, the request is invalid.\r\n - If neither exemption is selected, at least one of the allowance/withholding fields must be provided: `Step1AAllowances`, `Step1BAllowances`, `Step1CTotalAllowances`, or `Step2AdditionalWithholdingAmount`.\r\n - If exactly one exemption is selected, the allowance and additional withholding fields must be zero or empty.\r\n- Additional withholding amounts must be non-negative and use two decimal places when provided.\r\n \r\nBehavior highlights:\r\n- The request model is mapped to a service model and dispatched to the California DE 4 command via MediatR.\r\n- The California DE 4 mapping sub-command determines the correct California jurisdiction based on filing status\r\n and sets allowances (99 if exempt), then creates the tax onboarding payload.\r\n- On success, this endpoint returns 204 No Content.\r\n \r\nRoute: POST /Employees/{employeeId}/Onboarding/TaxForm/State/California/DE4/Year/2025\r\nAuthorization: EMPLOYEETAXFORM_WRITE (Service, ServiceRep)\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employeetaxform-write ````",
"operationId": "EmployeesByEmployeeIdOnboardingTaxFormStateCaliforniaDE4Year2025Post",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The employee identifier.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The California DE 4 (2025 revision) payload for the employee.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.CaliforniaDE4TaxForm2025Model"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.CaliforniaDE4TaxForm2025Model"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.CaliforniaDE4TaxForm2025Model"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.CaliforniaDE4TaxForm2025Model"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.CaliforniaDE4TaxForm2025Model"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.CaliforniaDE4TaxForm2025Model"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.CaliforniaDE4TaxForm2025Model"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.CaliforniaDE4TaxForm2025Model"
}
}
}
},
"responses": {
"204": {
"description": "The DE 4 was accepted and processed."
},
"400": {
"description": "The request was invalid; see validation errors for details."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden – the caller lacks required permissions."
},
"404": {
"description": "The employee was not found or is not visible to the caller."
}
},
"deprecated": true
}
},
"/Employees/{employeeId}/Onboarding/TaxForm/State/California/DE4/Year/2026": {
"post": {
"tags": [
"Enrollment"
],
"summary": "Submit California DE 4 (state withholding) – 2026 revision.",
"description": "Submits a California DE 4 (state withholding) form for the specified employee for the 2026 form revision.\r\nYear/2026 in the route denotes the form's revision year.\r\n \r\nThe request is validated using data annotations and domain rules. Key validations include:\r\n- Required employee demographic fields and SSN format (xxx-xx-xxxx).\r\n- Region must be a valid 2-letter US state code; the handler treats this as California-specific logic.\r\n- Filing status: exactly one of `SingleOrMarriedTwoIncome`, `MarriedOneIncome`, or `HeadOfHousehold` must be selected.\r\n- Exempt/allowances rules:\r\n - If both `Step3Exempt` and `Step4Exempt` are selected, the request is invalid.\r\n - If neither exemption is selected, at least one of the allowance/withholding fields must be provided: `Step1AAllowances`, `Step1BAllowances`, `Step1CTotalAllowances`, or `Step2AdditionalWithholdingAmount`.\r\n - If exactly one exemption is selected, the allowance and additional withholding fields must be zero or empty.\r\n- Additional withholding amounts must be non-negative and use two decimal places when provided.\r\n \r\nBehavior highlights:\r\n- The request model is mapped to a service model and dispatched to the California DE 4 command via MediatR.\r\n- The California DE 4 mapping sub-command determines the correct California jurisdiction based on filing status\r\n and sets allowances (99 if exempt), then creates the tax onboarding payload.\r\n- On success, this endpoint returns 204 No Content.\r\n \r\nRoute: POST /Employees/{employeeId}/Onboarding/TaxForm/State/California/DE4/Year/2026\r\nAuthorization: EMPLOYEETAXFORM_WRITE (Service, ServiceRep)\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employeetaxform-write ````",
"operationId": "EmployeesByEmployeeIdOnboardingTaxFormStateCaliforniaDE4Year2026Post",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The employee identifier.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The California DE 4 (2026 revision) payload for the employee.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.CaliforniaDE4TaxForm2026Model"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.CaliforniaDE4TaxForm2026Model"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.CaliforniaDE4TaxForm2026Model"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.CaliforniaDE4TaxForm2026Model"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.CaliforniaDE4TaxForm2026Model"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.CaliforniaDE4TaxForm2026Model"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.CaliforniaDE4TaxForm2026Model"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.CaliforniaDE4TaxForm2026Model"
}
}
}
},
"responses": {
"204": {
"description": "The DE 4 was accepted and processed."
},
"400": {
"description": "The request was invalid; see validation errors for details."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden – the caller lacks required permissions."
},
"404": {
"description": "The employee was not found or is not visible to the caller."
}
}
}
},
"/Employees/{employeeId}/Onboarding/TaxForm/State/Colorado/DR0004/Year/2025": {
"post": {
"tags": [
"Enrollment"
],
"summary": "Submit Colorado DR0004 (state withholding) – 2025 revision.",
"description": "Submits an Colorado DR0004 (state withholding) form for the specified employee for the 2025 form revision.\r\nYear/2025 in the route denotes the form’s revision year.\r\n\r\nThe request is validated using data annotations and domain rules. Key validations include:\r\n \r\nBehavior highlights:\r\n- The request model is mapped directly to a service model and dispatched to the Colorado W-4 command via MediatR.\r\n- Domain validation is enforced in the Colorado mapping sub-command.\r\n- On success, this endpoint returns 204 No Content.\r\n \r\nRoute: POST /Employees/{employeeId}/onboarding/State/Colorado/DR0004/Year/2025\r\nAuthorization: EMPLOYEETAXFORM_WRITE (Service, ServiceRep)\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employeetaxform-write ````",
"operationId": "EmployeesByEmployeeIdOnboardingTaxFormStateColoradoDR0004Year2025Post",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The employee identifier.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The Colorado state DR0004 (2025 revision) payload for the employee.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ColoradoDR0004TaxForm2025Model"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ColoradoDR0004TaxForm2025Model"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ColoradoDR0004TaxForm2025Model"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ColoradoDR0004TaxForm2025Model"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ColoradoDR0004TaxForm2025Model"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ColoradoDR0004TaxForm2025Model"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ColoradoDR0004TaxForm2025Model"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ColoradoDR0004TaxForm2025Model"
}
}
}
},
"responses": {
"204": {
"description": "The DR0004 was accepted and processed."
},
"400": {
"description": "The request was invalid; see validation errors for details."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden – the caller lacks required permissions."
},
"404": {
"description": "The employee was not found or is not visible to the caller."
}
}
}
},
"/Employees/{employeeId}/Onboarding/TaxForm/State/Connecticut/CTW4/Year/2024": {
"post": {
"tags": [
"Enrollment"
],
"summary": "Submit Connecticut CT-W4 (state withholding) – 2024 revision.",
"description": "Submits a Connecticut CT-W4 (state withholding) form for the specified employee for the 2024 form revision.\r\nYear/2024 in the route denotes the form's revision year.\r\n \r\nThe request is validated using data annotations and domain rules. Key validations include:\r\n- Required employee demographic fields and SSN format (xxx-xx-xxxx).\r\n- Valid Connecticut Withholding Codes selection.\r\n- Additional withholding amounts must be non-negative and use two decimal places.\r\n \r\nBehavior highlights:\r\n- Filing status is mapped to the appropriate jurisdiction for Connecticut.\r\n- Withholding Codes and additional withholding amounts are used to update employee tax setup.\r\n \r\nRoute: POST /Employees/{employeeId}/Onboarding/TaxForm/State/Connecticut/CTW4/Year/2024\r\nAuthorization: EMPLOYEETAXFORM_WRITE (Service, ServiceRep)\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employeetaxform-write ````",
"operationId": "EmployeesByEmployeeIdOnboardingTaxFormStateConnecticutCTW4Year2024Post",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The employee identifier.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The Connecticut CT-W4 (2024 revision) payload for the employee.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ConnecticutCTW4TaxForm2024Model"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ConnecticutCTW4TaxForm2024Model"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ConnecticutCTW4TaxForm2024Model"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ConnecticutCTW4TaxForm2024Model"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ConnecticutCTW4TaxForm2024Model"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ConnecticutCTW4TaxForm2024Model"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ConnecticutCTW4TaxForm2024Model"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ConnecticutCTW4TaxForm2024Model"
}
}
}
},
"responses": {
"204": {
"description": "The CT-W4 was accepted and processed."
},
"400": {
"description": "The request was invalid; see validation errors for details."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden – the caller lacks required permissions."
},
"404": {
"description": "The employee was not found or is not visible to the caller."
}
},
"deprecated": true
}
},
"/Employees/{employeeId}/Onboarding/TaxForm/State/Connecticut/CTW4/Year/2026": {
"post": {
"tags": [
"Enrollment"
],
"summary": "Submit Connecticut CT-W4 (state withholding) – 2026 revision.",
"description": "Submits a Connecticut CT-W4 (state withholding) form for the specified employee for the 2026 form revision.\r\nYear/2026 in the route denotes the form's revision year.\r\n \r\nThe request is validated using data annotations and domain rules. Key validations include:\r\n- Required employee demographic fields and SSN format (xxx-xx-xxxx).\r\n- Valid Connecticut Withholding Codes selection.\r\n- Additional withholding amounts must be non-negative and use two decimal places.\r\n \r\nBehavior highlights:\r\n- Filing status is mapped to the appropriate jurisdiction for Connecticut.\r\n- Withholding Codes and additional withholding amounts are used to update employee tax setup.\r\n \r\nRoute: POST /Employees/{employeeId}/Onboarding/TaxForm/State/Connecticut/CTW4/Year/2026\r\nAuthorization: EMPLOYEETAXFORM_WRITE (Service, ServiceRep)\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employeetaxform-write ````",
"operationId": "EmployeesByEmployeeIdOnboardingTaxFormStateConnecticutCTW4Year2026Post",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The employee identifier.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The Connecticut CT-W4 (2026 revision) payload for the employee.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ConnecticutCTW4TaxForm2026Model"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ConnecticutCTW4TaxForm2026Model"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ConnecticutCTW4TaxForm2026Model"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ConnecticutCTW4TaxForm2026Model"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ConnecticutCTW4TaxForm2026Model"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ConnecticutCTW4TaxForm2026Model"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ConnecticutCTW4TaxForm2026Model"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.ConnecticutCTW4TaxForm2026Model"
}
}
}
},
"responses": {
"204": {
"description": "The CT-W4 was accepted and processed."
},
"400": {
"description": "The request was invalid; see validation errors for details."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden – the caller lacks required permissions."
},
"404": {
"description": "The employee was not found or is not visible to the caller."
}
}
}
},
"/Employees/{employeeId}/Onboarding/TaxForm/State/Delaware/DEW4/Year/2022": {
"post": {
"tags": [
"Enrollment"
],
"summary": "Submit Delaware DE-W4 (state withholding) – 2022 revision.",
"description": "Submits a Delaware DE-W4 (state withholding) form for the specified employee for the 2022 form revision.\r\nYear/2022 in the route denotes the form’s revision year.\r\n \r\nThe request is validated using data annotations and domain rules. Key validations include:\r\n- Required employee demographic fields and SSN format (xxx-xx-xxxx).\r\n- Delaware Marital status selection and dependents range.\r\n- Additional withholding amounts must be non-negative and use two decimal places.\r\n \r\nBehavior highlights:\r\n- Filing status is mapped to the appropriate jurisdiction for Delaware.\r\n- Dependents and additional withholding amounts are used to update employee tax setup.\r\n \r\nRoute: POST /Employees/{employeeId}/Onboarding/TaxForm/State/Delaware/DEW4/Year/2023\r\nAuthorization: EMPLOYEETAXFORM_WRITE (Service, ServiceRep)\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employeetaxform-write ````",
"operationId": "EmployeesByEmployeeIdOnboardingTaxFormStateDelawareDEW4Year2022Post",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The employee identifier.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The Delaware DE-W4 (2023 revision) payload for the employee.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.DelawareDEW4TaxForm2022Model"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.DelawareDEW4TaxForm2022Model"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.DelawareDEW4TaxForm2022Model"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.DelawareDEW4TaxForm2022Model"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.DelawareDEW4TaxForm2022Model"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.DelawareDEW4TaxForm2022Model"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.DelawareDEW4TaxForm2022Model"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.DelawareDEW4TaxForm2022Model"
}
}
}
},
"responses": {
"204": {
"description": "The DE-W4 was accepted and processed."
},
"400": {
"description": "The request was invalid; see validation errors for details."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden – the caller lacks required permissions."
},
"404": {
"description": "The employee was not found or is not visible to the caller."
}
}
}
},
"/Employees/{employeeId}/Onboarding/TaxForm/State/DistrictOfColumbia/DCD4/Year/2018": {
"post": {
"tags": [
"Enrollment"
],
"summary": "Submit District of Columbia D-4 (state withholding) – 2018 revision.",
"description": "Submits a District of Columbia D-4 (DC Withholding Allowance Certificate) form for the specified employee\r\nfor the 2018 form revision. Year/2018 in the route denotes the form's revision year.\r\n \r\nThe request is validated using data annotations and domain rules. Key validations include:\r\n- Required employee demographic fields and SSN format (xxx-xx-xxxx).\r\n- Exactly one filing status must be selected (Single, Married Filing Jointly,\r\n Married Filing Separately, Head of Household, or Married Filing Separately on Same Return).\r\n- Line 2 (Total Withholding Allowances) must be 0-99.\r\n- Line 3 (Additional withholding) must be non-negative and use two decimal places.\r\n- Line 4 (Exempt): when true, Additional Withholding must be 0 or null.\r\n- Line 5 (DomicileOutsideDC): when true, DomicileState is required.\r\n \r\nBehavior highlights:\r\n- Filing status determines the tax jurisdiction:\r\n Single → DCSINGLE (193), Married Filing Jointly → DCMFJ (249),\r\n Married Filing Separately → DCMFS (192), Head of Household → DCHOH (248),\r\n Married Filing Separately on Same Return → DCMFSS (250).\r\n- When Exempt is true, allowances are set to 99 and additional withholding is forced to 0.\r\n- EmployeeRoot fields are only set when the employee's Region is DC.\r\n- Dependents (Line e from worksheet) map to Dependents.\r\n- Total Withholding Allowances map to Allowances (overridden to 99 when Exempt).\r\n \r\nRoute: POST /Employees/{employeeId}/Onboarding/TaxForm/State/DistrictOfColumbia/DCD4/Year/2018\r\nAuthorization: EMPLOYEETAXFORM_WRITE (Service, ServiceRep)\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employeetaxform-write ````",
"operationId": "EmployeesByEmployeeIdOnboardingTaxFormStateDistrictOfColumbiaDCD4Year2018Post",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The employee identifier.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The District of Columbia D-4 (2018 revision) payload for the employee.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.DistrictOfColumbiaDCD4TaxForm2018Model"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.DistrictOfColumbiaDCD4TaxForm2018Model"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.DistrictOfColumbiaDCD4TaxForm2018Model"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.DistrictOfColumbiaDCD4TaxForm2018Model"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.DistrictOfColumbiaDCD4TaxForm2018Model"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.DistrictOfColumbiaDCD4TaxForm2018Model"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.DistrictOfColumbiaDCD4TaxForm2018Model"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.DistrictOfColumbiaDCD4TaxForm2018Model"
}
}
}
},
"responses": {
"204": {
"description": "The D-4 was accepted and processed."
},
"400": {
"description": "The request was invalid; see validation errors for details."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden – the caller lacks required permissions."
},
"404": {
"description": "The employee was not found or is not visible to the caller."
}
}
}
},
"/Employees/{employeeId}/Onboarding/TaxForm/State/Georgia/G4/Year/2024": {
"post": {
"tags": [
"Enrollment"
],
"summary": "Submit Georgia G-4 (state withholding) – 2024-08-15 revision.",
"description": "Submits a Georgia G-4 (state withholding) form for the specified employee for the 2024 form revision.\r\nYear/2024 in the route denotes the form’s revision year.\r\n \r\nValidation and behavior:\r\n- Visibility: Employee must be visible to the caller.\r\n- Model validation: Data annotations are checked for the request model, then domain rules are enforced.\r\n- Region/state validation: `Region` must be a valid 2-letter US state; GA is treated as resident state.\r\n- Box 7 requirements: When not exempt in Box 8, `Box7MaritalStatus` (A/B/C/D) and `Box7TotalAllowances` are required.\r\n- Box 8 exemption rules: If either `Box8AExemptFromWithholding` or `Box8BExemptFromWithholding` is true, Box 6 must be empty/zero and both Box 7 fields must be empty/zero. If `Box8BExemptFromWithholding` is true, both `Box8BStateOfResidence` and `Box8BStateOfResidenceSpouse` are required and must be valid states.\r\n \r\nMapping to payroll:\r\n- Jurisdiction is derived from `Box7MaritalStatus`.\r\n- Exempt selections set allowances to 99.\r\n- Dependents map to Box 4; additional withholding maps to Box 6 when not exempt.\r\n- Resident state uses GA jurisdiction and sets `EmployeeTaxRegion` and related fields; non-resident omits region-specific fields.\r\n \r\nOn success, this endpoint returns 204 No Content.\r\n \r\nRoute: POST /Employees/{employeeId}/Onboarding/TaxForm/State/Georgia/G4/Year/2024\r\nAuthorization: EMPLOYEETAXFORM_WRITE (Service, ServiceRep)\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employeetaxform-write ````",
"operationId": "EmployeesByEmployeeIdOnboardingTaxFormStateGeorgiaG4Year2024Post",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The employee identifier.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The Georgia G-4 (2024 revision) payload for the employee.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.GeorgiaG4TaxForm2024Model"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.GeorgiaG4TaxForm2024Model"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.GeorgiaG4TaxForm2024Model"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.GeorgiaG4TaxForm2024Model"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.GeorgiaG4TaxForm2024Model"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.GeorgiaG4TaxForm2024Model"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.GeorgiaG4TaxForm2024Model"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.GeorgiaG4TaxForm2024Model"
}
}
}
},
"responses": {
"204": {
"description": "The G-4 was accepted and processed."
},
"400": {
"description": "The request was invalid; see validation errors for details.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden – the caller lacks required permissions."
},
"404": {
"description": "The employee was not found or is not visible to the caller."
}
}
}
},
"/Employees/{employeeId}/Onboarding/TaxForm/State/Hawaii/HW4/Year/2025": {
"post": {
"tags": [
"Enrollment"
],
"summary": "Submit Hawaii HW-4 (state withholding) – 2025 revision.",
"description": "Submits a Hawaii HW-4 (state withholding) form for the specified employee for the 2025 form revision.\r\nYear/2025 in the route denotes the form's revision year.\r\n \r\nThe request is validated using data annotations and domain rules. Key validations include:\r\n- Required employee demographic fields and SSN format (xxx-xx-xxxx).\r\n- Exactly one filing status must be selected (Single, Married, or MarriedButWithholdAtHigherSingleRate).\r\n- Exemption flags (CertifiedDisabled, NonresidentMilitary) are mutually exclusive with Line4TotalAllowances.\r\n- Line4TotalAllowances are required when no exemption is claimed. \r\n- Additional withholding amounts must be non-negative and use two decimal places.\r\n- Additional withholding must be Zero or Empty if exempt from withholding\r\n \r\nBehavior highlights:\r\n- Filing status is mapped to the appropriate Hawaii jurisdiction.\r\n- When exempt (CertifiedDisabled or NonresidentMilitary), allowances are set to 99. \r\n- LineEDependents and additional withholding amounts are used to update employee tax setup.\r\n\r\nRoute: POST /Employees/{employeeId}/Onboarding/TaxForm/State/Hawaii/HW4/Year/2025\r\nAuthorization: EMPLOYEETAXFORM_WRITE (Service, ServiceRep)\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employeetaxform-write ````",
"operationId": "EmployeesByEmployeeIdOnboardingTaxFormStateHawaiiHW4Year2025Post",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The employee identifier.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The Hawaii HW-4 (2025 revision) payload for the employee.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.HawaiiHW4TaxForm2025Model"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.HawaiiHW4TaxForm2025Model"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.HawaiiHW4TaxForm2025Model"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.HawaiiHW4TaxForm2025Model"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.HawaiiHW4TaxForm2025Model"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.HawaiiHW4TaxForm2025Model"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.HawaiiHW4TaxForm2025Model"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.HawaiiHW4TaxForm2025Model"
}
}
}
},
"responses": {
"204": {
"description": "The HW-4 was accepted and processed."
},
"400": {
"description": "The request was invalid; see validation errors for details."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden – the caller lacks required permissions."
},
"404": {
"description": "The employee was not found or is not visible to the caller."
}
}
}
},
"/Employees/{employeeId}/Onboarding/TaxForm/State/Idaho/W4/Year/2025": {
"post": {
"tags": [
"Enrollment"
],
"summary": "Submit Idaho W-4 (state withholding) — 2025 revision.",
"description": "Submits an Idaho W-4 (state withholding) form for the specified employee for the 2025 form revision.\r\nYear/2025 in the route denotes the form's revision year.\r\n\r\nThe request is validated using data annotations and domain rules. Key validations include:\r\n- Required employee demographic fields and SSN format (xxx-xx-xxxx).\r\n- Exactly one withholding status (Single, Married, or MarriedWithholdAtSingleRate) must be selected.\r\n- Allowances must be between 0 and 99 inclusive.\r\n- Additional withholding amount cannot be negative (null is treated as zero).\r\n \r\nOn success, this endpoint returns 204 No Content.\r\n \r\nRoute: POST /Employees/{employeeId}/Onboarding/TaxForm/State/Idaho/W4/Year/2025\r\nAuthorization: EMPLOYEETAXFORM_WRITE (Service, ServiceRep)\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employeetaxform-write ````",
"operationId": "EmployeesByEmployeeIdOnboardingTaxFormStateIdahoW4Year2025Post",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The employee identifier.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The Idaho W-4 (2025 revision) payload for the employee.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.IdahoW4TaxForm2025Model"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.IdahoW4TaxForm2025Model"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.IdahoW4TaxForm2025Model"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.IdahoW4TaxForm2025Model"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.IdahoW4TaxForm2025Model"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.IdahoW4TaxForm2025Model"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.IdahoW4TaxForm2025Model"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.IdahoW4TaxForm2025Model"
}
}
}
},
"responses": {
"204": {
"description": "The W-4 was accepted and processed."
},
"400": {
"description": "The request was invalid; see validation errors for details."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden — the caller lacks required permissions."
},
"404": {
"description": "The employee was not found or is not visible to the caller."
}
}
}
},
"/Employees/{employeeId}/Onboarding/TaxForm/State/Illinois/ILW4/Year/2023": {
"post": {
"tags": [
"Enrollment"
],
"summary": "Submit Illinois IL-W4 (state withholding) – 2023 revision.",
"description": "Submits a Illinois IL-W4 (state withholding) form for the specified employee for the 2023 form revision.\r\nYear/2023 in the route denotes the form’s revision year.\r\n \r\nThe request is validated using data annotations and domain rules. Key validations include:\r\n- Required employee demographic fields and SSN format (xxx-xx-xxxx).\r\n- Illinois Exemption from Federal and State withholding \r\n- Basic and Additional allowances range.\r\n- Additional withholding amounts must be non-negative and use two decimal places.\r\n \r\nBehavior highlights:\r\n- Filing status is mapped to the appropriate jurisdiction for Illinois.\r\n- Dependents and additional withholding amounts are used to update employee tax setup.\r\n \r\nRoute: POST /Employees/{employeeId}/Onboarding/TaxForm/State/Illinois/ILW4/Year/2023\r\nAuthorization: EMPLOYEETAXFORM_WRITE (Service, ServiceRep)\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employeetaxform-write ````",
"operationId": "EmployeesByEmployeeIdOnboardingTaxFormStateIllinoisILW4Year2023Post",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The employee identifier.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The Illinois IL-W4 (2023 revision) payload for the employee.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.IllinoisILW4TaxForm2023Model"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.IllinoisILW4TaxForm2023Model"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.IllinoisILW4TaxForm2023Model"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.IllinoisILW4TaxForm2023Model"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.IllinoisILW4TaxForm2023Model"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.IllinoisILW4TaxForm2023Model"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.IllinoisILW4TaxForm2023Model"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.IllinoisILW4TaxForm2023Model"
}
}
}
},
"responses": {
"204": {
"description": "The IL-W4 was accepted and processed."
},
"400": {
"description": "The request was invalid; see validation errors for details."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden – the caller lacks required permissions."
},
"404": {
"description": "The employee was not found or is not visible to the caller."
}
}
}
},
"/Employees/{employeeId}/Onboarding/TaxForm/State/Indiana/WH4/Year/2023": {
"post": {
"tags": [
"Enrollment"
],
"summary": "Submit Indiana WH-4 (state withholding) – 08-2023 revision.",
"description": "Submits an Indiana WH-4 (state withholding) form for the specified employee for the 2023 form revision.\r\nYear/2023 in the route denotes the form’s revision year.\r\n \r\nThe request is validated using data annotations and domain rules. Key validations include:\r\n- Required employee demographic fields and SSN format (xxx-xx-xxxx).\r\n- Indiana filing status selection and dependents range.\r\n- Additional withholding amounts must be non-negative and use two decimal places.\r\n \r\nBehavior highlights:\r\n- Filing status is mapped to the appropriate jurisdiction for Indiana.\r\n- Dependents and additional withholding amounts are used to update employee tax setup.\r\n \r\nRoute: POST /Employees/{employeeId}/Onboarding/TaxForm/State/Indiana/WH4/Year/2023\r\nAuthorization: EMPLOYEETAXFORM_WRITE (Service, ServiceRep)\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employeetaxform-write ````",
"operationId": "EmployeesByEmployeeIdOnboardingTaxFormStateIndianaWH4Year2023Post",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The employee identifier.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The Indiana WH-4 (2023 revision) payload for the employee.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EnrollmentService.API.Models.IndianaWH4TaxForm2023Model"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EnrollmentService.API.Models.IndianaWH4TaxForm2023Model"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EnrollmentService.API.Models.IndianaWH4TaxForm2023Model"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EnrollmentService.API.Models.IndianaWH4TaxForm2023Model"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EnrollmentService.API.Models.IndianaWH4TaxForm2023Model"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EnrollmentService.API.Models.IndianaWH4TaxForm2023Model"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EnrollmentService.API.Models.IndianaWH4TaxForm2023Model"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EnrollmentService.API.Models.IndianaWH4TaxForm2023Model"
}
}
}
},
"responses": {
"204": {
"description": "The WH-4 was accepted and processed."
},
"400": {
"description": "The request was invalid; see validation errors for details."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden – the caller lacks required permissions."
},
"404": {
"description": "The employee was not found or is not visible to the caller."
}
}
}
},
"/Employees/{employeeId}/Onboarding/TaxForm/State/Iowa/IAW4/Year/2025": {
"post": {
"tags": [
"Enrollment"
],
"summary": "Submit Iowa IA W-4 (state withholding) – 2025 revision.",
"description": "Submits an Iowa IA W-4 (Employee Withholding Allowance Certificate) form for the specified employee\r\nfor the 2025 form revision. Year/2025 in the route denotes the form's revision year.\r\n \r\nThe request is validated using data annotations and domain rules. Key validations include:\r\n- Required employee demographic fields and SSN format (xxx-xx-xxxx).\r\n- Exactly one filing status must be selected (Other, Head of Household, Married filing jointly, or Qualifying Surviving Spouse).\r\n- Lines 1–6 individual allowance values and Line 7 total must be consistent (Line 7 = Lines 1+2+3+4+5+6).\r\n- Line 2 (Dependent Allowances) must be divisible by 40.\r\n- Additional withholding (Line 8) must be non-negative and use two decimal places.\r\n- Exempt flags and additional withholding (Line 8) are mutually exclusive.\r\n \r\nBehavior highlights:\r\n- Filing status is mapped to the appropriate Iowa jurisdiction (IASINGLE, IAMAR, or IAHOH).\r\n- Married filing jointly with spouse earned income uses the IASINGLE jurisdiction with MarriedFilingSingle marital status.\r\n- Qualifying Surviving Spouse uses the IAMAR jurisdiction with Married marital status.\r\n- Exemption checkboxes (Exempt or Military Spouse) determine exempt status and set allowances to 99.\r\n- TotalAllowances (Line 7) maps to AlternativeStandardDeduction.\r\n- Additional withholding (Line 8) maps to additional withholding amount.\r\n \r\nRoute: POST /Employees/{employeeId}/Onboarding/TaxForm/State/Iowa/IAW4/Year/2025\r\nAuthorization: EMPLOYEETAXFORM_WRITE (Service, ServiceRep)\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employeetaxform-write ````",
"operationId": "EmployeesByEmployeeIdOnboardingTaxFormStateIowaIAW4Year2025Post",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The employee identifier.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The Iowa IA W-4 (2025 revision) payload for the employee.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.IowaIAW4TaxForm2025Model"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.IowaIAW4TaxForm2025Model"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.IowaIAW4TaxForm2025Model"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.IowaIAW4TaxForm2025Model"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.IowaIAW4TaxForm2025Model"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.IowaIAW4TaxForm2025Model"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.IowaIAW4TaxForm2025Model"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.IowaIAW4TaxForm2025Model"
}
}
}
},
"responses": {
"204": {
"description": "The IA W-4 was accepted and processed."
},
"400": {
"description": "The request was invalid; see validation errors for details."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden – the caller lacks required permissions."
},
"404": {
"description": "The employee was not found or is not visible to the caller."
}
}
}
},
"/Employees/{employeeId}/Onboarding/TaxForm/State/Kansas/K4/Year/2024": {
"post": {
"tags": [
"Enrollment"
],
"summary": "Submit Kansas K-4 (state withholding) – 2024 Revision.",
"description": "Submits a Kansas K-4 (state withholding) form for the specified employee for the 2024 form revision (Rev. 7-24).\r\nYear/2024 in the route denotes the form’s revision year.\r\n \r\nThe request is validated using data annotations and domain rules. Key validations include:\r\n- Required employee demographic fields and SSN format.\r\n- Validation of allowance lines (A through F) and total allowances.\r\n- Additional withholding amounts must be non-negative and use two decimal places.\r\n \r\nBehavior highlights:\r\n- Filing status is mapped to the appropriate jurisdiction for Kansas.\r\n- Allowances and additional withholding amounts are used to update employee tax setup.\r\n- On success, this endpoint returns 204 No Content.\r\n \r\nRoute: POST /Employees/{employeeId}/Onboarding/TaxForm/State/Kansas/K4/Year/2024\r\nAuthorization: EMPLOYEETAXFORM_WRITE (Service, ServiceRep)\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employeetaxform-write ````",
"operationId": "EmployeesByEmployeeIdOnboardingTaxFormStateKansasK4Year2024Post",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The employee identifier.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The Kansas K-4 (2024 revision) payload for the employee.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.KansasK4TaxForm2024Model"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.KansasK4TaxForm2024Model"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.KansasK4TaxForm2024Model"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.KansasK4TaxForm2024Model"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.KansasK4TaxForm2024Model"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.KansasK4TaxForm2024Model"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.KansasK4TaxForm2024Model"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.KansasK4TaxForm2024Model"
}
}
}
},
"responses": {
"204": {
"description": "The K-4 was accepted and processed."
},
"400": {
"description": "The request was invalid; see validation errors for details."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden – the caller lacks required permissions."
},
"404": {
"description": "The employee was not found or is not visible to the caller."
}
}
}
},
"/Employees/{employeeId}/Onboarding/TaxForm/State/Kentucky/K4/Year/2026": {
"post": {
"tags": [
"Enrollment"
],
"summary": "Submit Kentucky K-4 (state withholding) – 2026 revision.",
"description": "Submits a Kentucky K-4 (state withholding) form for the specified employee for the 2026 form revision.\r\nYear/2026 in the route denotes the form’s revision year.\r\n \r\nThe request is validated using data annotations and domain rules. Key validations include:\r\n \r\nBehavior highlights:\r\n- The request model is mapped directly to a service model and dispatched to the Kentucky K-4 command via MediatR.\r\n- Domain validation is enforced in the Kentucky mapping sub-command.\r\n- On success, this endpoint returns 204 No Content.\r\n\r\nRoute: POST /Employees/{employeeId}/Onboarding/TaxForm/State/Kentucky/K4/Year/2026\r\nAuthorization: EMPLOYEETAXFORM_WRITE (Service, ServiceRep)\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employeetaxform-write ````",
"operationId": "EmployeesByEmployeeIdOnboardingTaxFormStateKentuckyK4Year2026Post",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The employee identifier.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The Kentucky K-4 (2026 revision) payload for the employee.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.KentuckyK4TaxForm2026Model"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.KentuckyK4TaxForm2026Model"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.KentuckyK4TaxForm2026Model"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.KentuckyK4TaxForm2026Model"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.KentuckyK4TaxForm2026Model"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.KentuckyK4TaxForm2026Model"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.KentuckyK4TaxForm2026Model"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.KentuckyK4TaxForm2026Model"
}
}
}
},
"responses": {
"204": {
"description": "The K-4 was accepted and processed."
},
"400": {
"description": "The request was invalid; see validation errors for details."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden – the caller lacks required permissions."
},
"404": {
"description": "The employee was not found or is not visible to the caller."
}
}
}
},
"/Employees/{employeeId}/Onboarding/TaxForm/State/Louisiana/L4/Year/2026": {
"post": {
"tags": [
"Enrollment"
],
"summary": "Submit Louisiana L-4 (employee's withholding certificate) – 1/26 revision.",
"description": "Submits a Louisiana L-4 Employee's Withholding Certificate (form R-1300) for the specified employee\r\nfor the 1/26 form revision.\r\nYear/2026 in the route denotes the form's revision year.\r\n \r\nThe request is validated using data annotations and Louisiana-specific domain rules. Key validations include:\r\n- Required employee demographic fields and SSN format (xxx-xx-xxxx).\r\n- Region must be a valid 2-letter US state code.\r\n- Filing status must be 0, 1, or 2 (Block A standard deduction level).\r\n- Number of dependents must be between 0 and 99.\r\n- Additional withholding (Line 7) allows 2 decimal places.\r\n \r\nBehavior highlights:\r\n- Filing status determines the tax jurisdiction: 0 or 1 → LA1EX (JurisId 109),\r\n 2 → LA2EX (JurisId 110).\r\n- Dependents are stored separately from the filing status allowances.\r\n- EmployeeRoot tax fields are only updated when the employee's region is LA (resident).\r\n- On success, this endpoint returns 204 No Content.\r\n \r\nRoute: POST /Employees/{employeeId}/Onboarding/TaxForm/State/Louisiana/L4/Year/2026\r\nAuthorization: EMPLOYEETAXFORM_WRITE (Service, ServiceRep)\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employeetaxform-write ````",
"operationId": "EmployeesByEmployeeIdOnboardingTaxFormStateLouisianaL4Year2026Post",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The employee identifier.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The Louisiana L-4 (1/26 revision) payload for the employee.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.LouisianaL4TaxForm2026Model"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.LouisianaL4TaxForm2026Model"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.LouisianaL4TaxForm2026Model"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.LouisianaL4TaxForm2026Model"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.LouisianaL4TaxForm2026Model"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.LouisianaL4TaxForm2026Model"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.LouisianaL4TaxForm2026Model"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.LouisianaL4TaxForm2026Model"
}
}
}
},
"responses": {
"204": {
"description": "The L-4 was accepted and processed."
},
"400": {
"description": "The request was invalid; see validation errors for details."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden – the caller lacks required permissions."
},
"404": {
"description": "The employee was not found or is not visible to the caller."
}
}
}
},
"/Employees/{employeeId}/Onboarding/TaxForm/State/Louisiana/L4E/Year/2025": {
"post": {
"tags": [
"Enrollment"
],
"summary": "Submit Louisiana L-4E (certificate of exemption from withholding) – 2025 revision.",
"description": "Submits a Louisiana L-4E Certificate of Exemption from Withholding for the specified employee\r\nfor the 2025 form revision.\r\nYear/2025 in the route denotes the form's revision year.\r\n \r\nThe request is validated using data annotations and Louisiana specific domain rules. Key validations include:\r\n- Required employee demographic fields and SSN format (xxx-xx-xxxx).\r\n- Region must be a valid 2-letter US state code.\r\n- At least one of `Exempt1NoTaxLiability` or `Exempt2MilitarySpouseSCRA` must be selected.\r\n- `TaxDomicileState` is required when `Exempt2MilitarySpouseSCRA` is true and must be a valid state.\r\n \r\nBehavior highlights:\r\n- The request model is mapped to a service model and dispatched to the Louisiana L-4E command via MediatR.\r\n- The handler always uses the LA2EX jurisdiction (JurisId 110) with allowances hardcoded to 99.\r\n- On success, this endpoint returns 204 No Content.\r\n \r\nRoute: POST /Employees/{employeeId}/Onboarding/TaxForm/State/Louisiana/L4E/Year/2025\r\nAuthorization: EMPLOYEETAXFORM_WRITE (Service, ServiceRep)\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employeetaxform-write ````",
"operationId": "EmployeesByEmployeeIdOnboardingTaxFormStateLouisianaL4EYear2025Post",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The employee identifier.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The Louisiana L-4E (2025 revision) payload for the employee.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.LouisianaL4ETaxForm2025Model"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.LouisianaL4ETaxForm2025Model"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.LouisianaL4ETaxForm2025Model"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.LouisianaL4ETaxForm2025Model"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.LouisianaL4ETaxForm2025Model"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.LouisianaL4ETaxForm2025Model"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.LouisianaL4ETaxForm2025Model"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.LouisianaL4ETaxForm2025Model"
}
}
}
},
"responses": {
"204": {
"description": "The L-4E was accepted and processed."
},
"400": {
"description": "The request was invalid; see validation errors for details."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden – the caller lacks required permissions."
},
"404": {
"description": "The employee was not found or is not visible to the caller."
}
}
}
},
"/Employees/{employeeId}/Onboarding/TaxForm/State/Maine/W4ME/Year/2025": {
"post": {
"tags": [
"Enrollment"
],
"summary": "Submit Maine W-4ME (state withholding) – 2025 revision.",
"description": "Submits a Maine W-4ME (state withholding) form for the specified employee for the 2025 form revision.\r\nYear/2025 in the route denotes the form's revision year.\r\n \r\nThe request is validated using data annotations and domain rules. Key validations include:\r\n- Required employee demographic fields and SSN format (xxx-xx-xxxx).\r\n- Region must be a valid 2-letter US state code.\r\n- Filing status: exactly one of `SingleOrHeadOfHousehold`, `Married`, or `MarriedButHigherSingleRate` must be selected.\r\n- Exemption rules (Line 6):\r\n - At most one of `Step6AExempt`, `Step6BNoWithholding`, `Step6CNoTaxLiability`,\r\n `Step6DRetirementNoTaxLiability`, or `Step6EMilitarySpouseResidencyReliefAct` may be selected.\r\n - If no exemption is selected, `Step4TotalAllowances` must be provided.\r\n - If an exemption is selected, allowances and additional withholding must be zero or empty.\r\n- `Step7EnrolledTribalMember` may be selected independently of Line 6 exemptions.\r\n- Additional withholding amounts must be non-negative and use two decimal places when provided.\r\n \r\nBehavior highlights:\r\n- The request model is mapped to a service model and dispatched to the Maine W-4ME command via MediatR.\r\n- The Maine W-4ME mapping sub-command determines the correct Maine jurisdiction based on filing status\r\n and sets allowances (99 if exempt), then creates the tax onboarding payload.\r\n- On success, this endpoint returns 204 No Content.\r\n \r\nRoute: POST /Employees/{employeeId}/Onboarding/TaxForm/State/Maine/W4ME/Year/2026\r\nAuthorization: EMPLOYEETAXFORM_WRITE (Service, ServiceRep)\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employeetaxform-write ````",
"operationId": "EmployeesByEmployeeIdOnboardingTaxFormStateMaineW4MEYear2025Post",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The employee identifier.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The Maine W-4ME (2026 revision) payload for the employee.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MaineW4METaxForm2025Model"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MaineW4METaxForm2025Model"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MaineW4METaxForm2025Model"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MaineW4METaxForm2025Model"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MaineW4METaxForm2025Model"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MaineW4METaxForm2025Model"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MaineW4METaxForm2025Model"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MaineW4METaxForm2025Model"
}
}
}
},
"responses": {
"204": {
"description": "The W-4ME was accepted and processed."
},
"400": {
"description": "The request was invalid; see validation errors for details."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden – the caller lacks required permissions."
},
"404": {
"description": "The employee was not found or is not visible to the caller."
}
}
}
},
"/Employees/{employeeId}/Onboarding/TaxForm/State/Maryland/MW507/Year/2026": {
"post": {
"tags": [
"Enrollment"
],
"summary": "Submit Maryland MW507 (state withholding) – 2026 revision.",
"description": "Submits a Maryland MW507 (state withholding) form for the specified employee for the 2026 form revision.\r\nYear/2026 in the route denotes the form's revision year.\r\n \r\nThe request is validated using data annotations and domain rules. Key validations include:\r\n- Required employee demographic fields and SSN format (xxx-xx-xxxx).\r\n- `CountyOfResidence` is required and must be a valid Maryland county or Baltimore City.\r\n Valid values: Allegany, Anne Arundel, Baltimore City, Baltimore County, Calvert, Caroline, Carroll,\r\n Cecil, Charles, Dorchester, Frederick, Garrett, Harford, Howard, Kent, Montgomery,\r\n Prince George's, Queen Anne's, Somerset, St Mary's, Talbot, Washington, Wicomico, Worcester.\r\n- Exactly one filing status must be true: `IsSingle`, `IsMarried`, or `IsMarriedWithholdAtSingleRate`.\r\n- `Line1TotalExemptions` is required and must be in the range 0–99.\r\n- `Line2AdditionalWithholding` is optional; when provided it must be non-negative with two decimal places.\r\n- Line 3 exemption (`Line3Exempt`) requires both `Line3a` and `Line3b` to be true and a valid `Line3ExemptionYear`.\r\n- `Line4DomicileState` must be null or one of: DC, VA, WV. When provided, `Line4Exempt` must also be true.\r\n- When `Line8Exempt` is true, `Line8StateOfLegalResidence` must be provided, and vice versa.\r\n \r\nBehavior highlights:\r\n- The request model is mapped to a service model and dispatched to `MarylandMW507Command` via MediatR.\r\n- Domain validation is enforced in `MarylandMW5072026TaxMappingCommand`.\r\n- Filing status is mapped to `MaritalTaxStatusId` on the employee record (Single=2, Married=1, MarriedFilingSingle=4).\r\n- The county is translated to its Maryland county jurisdiction ID. Baltimore City additionally sets the municipality jurisdiction.\r\n- When any exemption line (3–8) is claimed, `Line1TotalExemptions` is overridden to 99.\r\n- On success, this endpoint returns 204 No Content.\r\n \r\nRoute: POST /Employees/{employeeId}/Onboarding/TaxForm/State/Maryland/MW507/Year/2026\r\nAuthorization: EMPLOYEETAXFORM_WRITE (Service, ServiceRep)\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employeetaxform-write ````",
"operationId": "EmployeesByEmployeeIdOnboardingTaxFormStateMarylandMW507Year2026Post",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The employee identifier.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The Maryland MW507 (2026 revision) payload for the employee.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MarylandMW507TaxForm2026Model"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MarylandMW507TaxForm2026Model"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MarylandMW507TaxForm2026Model"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MarylandMW507TaxForm2026Model"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MarylandMW507TaxForm2026Model"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MarylandMW507TaxForm2026Model"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MarylandMW507TaxForm2026Model"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MarylandMW507TaxForm2026Model"
}
}
}
},
"responses": {
"204": {
"description": "The MW507 was accepted and processed."
},
"400": {
"description": "The request was invalid; see validation errors for details."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden – the caller lacks required permissions."
},
"404": {
"description": "The employee was not found or is not visible to the caller."
}
}
}
},
"/Employees/{employeeId}/Onboarding/TaxForm/State/Massachusetts/M4/Year/2024": {
"post": {
"tags": [
"Enrollment"
],
"summary": "Submit Massachusetts M-4 (state withholding) – 2024 revision.",
"description": "Submits a Massachusetts M-4 (state withholding) form for the specified employee for the 2024 form revision.\r\nYear/2024 in the route denotes the form's revision year.\r\n \r\nThe request is validated using data annotations and domain rules. Key validations include:\r\n- Required employee demographic fields and SSN format (xxx-xx-xxxx). \r\n- Region must be a valid 2-letter US state code. \r\n- PersonalExemptions must be 1 or 2. \r\n- SpouseExemptions must be 0, 4 or 5.\r\n- Dependents must be between 0 and 99.\r\n- TotalExemptions must be between 0 and 99. \r\n- Additional withholding amounts must be non-negative (null is treated as zero)\r\n- Additional withholding must be Zero or Empty if exempt from withholding\r\n \r\nRoute: POST /Employees/{employeeId}/Onboarding/TaxForm/State/Massachusetts/M4/Year/2024\r\nAuthorization: EMPLOYEETAXFORM_WRITE (Service, ServiceRep)\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employeetaxform-write ````",
"operationId": "EmployeesByEmployeeIdOnboardingTaxFormStateMassachusettsM4Year2024Post",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The employee identifier.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The Massachusetts M-4 (2024 revision) payload for the employee.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MassachusettsM4TaxForm2024Model"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MassachusettsM4TaxForm2024Model"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MassachusettsM4TaxForm2024Model"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MassachusettsM4TaxForm2024Model"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MassachusettsM4TaxForm2024Model"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MassachusettsM4TaxForm2024Model"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MassachusettsM4TaxForm2024Model"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MassachusettsM4TaxForm2024Model"
}
}
}
},
"responses": {
"204": {
"description": "The M-4 was accepted and processed."
},
"400": {
"description": "The request was invalid; see validation errors for details."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden – the caller lacks required permissions."
},
"404": {
"description": "The employee was not found or is not visible to the caller."
}
}
}
},
"/Employees/{employeeId}/Onboarding/TaxForm/State/Michigan/MIW4/Year/2020": {
"post": {
"tags": [
"Enrollment"
],
"summary": "Submit Michigan MI-W4 (state withholding) – 12-2020 revision.",
"description": "Submits a Michigan MI-W4 (state withholding) form for the specified employee for the 2020 form revision.\r\nYear/2020 in the route denotes the form’s revision year.\r\n \r\nThe request is validated using data annotations and domain rules. Key validations include:\r\n- Required employee demographic fields and SSN format (xxx-xx-xxxx).\r\n- Michigan Exemption from Federal and State withholding \r\n- Additional withholding amounts must be non-negative and use two decimal places.\r\n \r\nBehavior highlights:\r\n- Filing status is mapped to the appropriate jurisdiction for Michigan.\r\n- Dependents and additional withholding amounts are used to update employee tax setup.\r\n\r\nRoute: POST /Employees/{employeeId}/Onboarding/TaxForm/State/Michigan/MIW4/Year/2020\r\nAuthorization: EMPLOYEETAXFORM_WRITE (Service, ServiceRep)\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employeetaxform-write ````",
"operationId": "EmployeesByEmployeeIdOnboardingTaxFormStateMichiganMIW4Year2020Post",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The employee identifier.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The Michigan MI-W4 (2020 revision) payload for the employee.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MichiganMIW4TaxForm2020Model"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MichiganMIW4TaxForm2020Model"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MichiganMIW4TaxForm2020Model"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MichiganMIW4TaxForm2020Model"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MichiganMIW4TaxForm2020Model"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MichiganMIW4TaxForm2020Model"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MichiganMIW4TaxForm2020Model"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MichiganMIW4TaxForm2020Model"
}
}
}
},
"responses": {
"204": {
"description": "The MI-W4 was accepted and processed."
},
"400": {
"description": "The request was invalid; see validation errors for details."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden – the caller lacks required permissions."
},
"404": {
"description": "The employee was not found or is not visible to the caller."
}
}
}
},
"/Employees/{employeeId}/Onboarding/TaxForm/State/Minnesota/W4MN/Year/2026": {
"post": {
"tags": [
"Enrollment"
],
"summary": "Submit Minnesota W-4MN (state withholding) – 2026 revision.",
"description": "Submits a Minnesota W-4MN (state withholding) form for the specified employee for the 2026 form revision.\r\nYear/2026 in the route denotes the form’s revision year.\r\n \r\nValidation and behavior:\r\n- Visibility: The employee must be visible to the caller; otherwise a 404 Not Found is returned.\r\n- Model validation: Data annotations on the request model are validated (required name/SSN/address/phone fields, formats, and lengths).\r\n- Region/state validation: `Region` must be a valid 2-letter US state.\r\n- Filing status: Exactly one of `SingleLegallySeparatedOrNonResidentSpouse`, `Married`, or `MarriedHigherWithholdingRate` must be selected.\r\n- Section selection: Exactly one of `Section1` (allowances) or `Section2` (exemptions) must be selected.\r\n- When Section 1 is selected:\r\n - `Section1Allowances` and `Section1AdditionalWithholding` are required.\r\n - No Section 2 fields may be provided (`Section2A`–`Section2F`, `Section2CStateOfDomicile`, `Section2DReservationName`, `Section2DCDIBNumber`).\r\n- When Section 2 is selected:\r\n - At least one of `Section2A`–`Section2F` must be selected.\r\n - If `Section2C` is selected, `Section2CStateOfDomicile` (2-letter state code) is required.\r\n - If `Section2D` is selected, both `Section2DReservationName` and `Section2DCDIBNumber` are required.\r\n - No Section 1 fields may be provided (`Section1A`–`Section1F`, `Section1Allowances`, `Section1AdditionalWithholding`).\r\n \r\nMapping to payroll/tax onboarding:\r\n- Jurisdiction is derived from marital selection:\r\n - `SingleLegallySeparatedOrNonResidentSpouse` or `MarriedHigherWithholdingRate` → MNSINGLE\r\n - `Married` → MNMAR\r\n- Resident state is determined by `Region == \"MN\"` (case-insensitive).\r\n - If resident: `EmployeeTaxRegion` is set to \"MN\" and `EmployeeTaxRegionJurisdictionId` is set to the mapped jurisdiction. `EmployeeTaxRegionExemptions` is set to `Section1Allowances` when Section 1 is selected; otherwise 99 (exempt). `EmployeeDependents` is set to 0.\r\n- An `EmployeeTaxItem` is always created with:\r\n - `EmployeeTaxTaxJurisdictionId` set to the mapped MN jurisdiction.\r\n - `EmployeeTaxAllowances` set to `Section1Allowances` when Section 1 is selected; otherwise 99.\r\n - `EmployeeTaxAdditionalWithholdingAmount` set to `Section1AdditionalWithholding` when Section 1 is selected; otherwise 0.\r\n - `EmployeeTaxDependents` set to 0 and `EmployeeTaxEmployerId` set from employee details.\r\n \r\nRoute: POST /Employees/{employeeId}/Onboarding/TaxForm/State/Minnesota/W4MN/Year/2026\r\nAuthorization: EMPLOYEETAXFORM_WRITE (Service, ServiceRep)\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employeetaxform-write ````",
"operationId": "EmployeesByEmployeeIdOnboardingTaxFormStateMinnesotaW4MNYear2026Post",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The employee identifier.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The Minnesota W-4MN (2026 revision) payload for the employee.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MinnesotaW4MN2026Model"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MinnesotaW4MN2026Model"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MinnesotaW4MN2026Model"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MinnesotaW4MN2026Model"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MinnesotaW4MN2026Model"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MinnesotaW4MN2026Model"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MinnesotaW4MN2026Model"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MinnesotaW4MN2026Model"
}
}
}
},
"responses": {
"204": {
"description": "The W-4MN was accepted and processed."
},
"400": {
"description": "The request was invalid; see validation errors for details."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden – the caller lacks required permissions."
},
"404": {
"description": "The employee was not found or is not visible to the caller."
}
}
}
},
"/Employees/{employeeId}/Onboarding/TaxForm/State/Mississippi/89350/Year/2025": {
"post": {
"tags": [
"Enrollment"
],
"summary": "Submit Mississippi 89-350 (state withholding) – 2025 revision.",
"description": "Submits a Mississippi 89-350 (Employee's Withholding Exemption Certificate) form for the\r\nspecified employee for the 2025 form revision. Year/2025 in the route denotes the form's\r\nrevision year.\r\n \r\nThe request is validated using data annotations and domain rules. Key validations include:\r\n- Required employee demographic fields and SSN format (xxx-xx-xxxx).\r\n- Region must be a valid 2-letter US state code.\r\n- Filing status: exactly one of `MaritalStatusSingle`, `MaritalStatusSpouseNotEmployed`,\r\n `MaritalStatusSpouseEmployed`, or `HeadOfFamily` must be selected.\r\n- If `MaritalStatusSpouseEmployed` is selected, `MaritalStatusSpouseEmployedAmount`\r\n must be between $0 and $12,000 in multiples of $500. Defaults to $12,000 if not provided.\r\n- Age and blind exemptions must be 0–4 (0 = None, 1 = Husband, 2 = Wife, 3 = Both, 4 = Single).\r\n- Additional withholding amounts must be non-negative and use two decimal places when provided.\r\n- `MilitaryExemption` requires supporting documents (DD-2058 and Military Spouse ID Card).\r\n \r\nBehavior highlights:\r\n- Exemption amounts are calculated server-side based on filing status, dependents,\r\n age, and blindness selections per Mississippi withholding tables.\r\n- The request model is mapped to a service model and dispatched to the Mississippi 89-350\r\n command via MediatR.\r\n- On success, this endpoint returns 204 No Content.\r\n \r\nRoute: POST /Employees/{employeeId}/Onboarding/TaxForm/State/Mississippi/89350/Year/2025\r\nAuthorization: EMPLOYEETAXFORM_WRITE (Service, ServiceRep)\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employeetaxform-write ````",
"operationId": "EmployeesByEmployeeIdOnboardingTaxFormStateMississippi89350Year2025Post",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The employee identifier.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The Mississippi 89-350 (2025 revision) payload for the employee.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.Mississippi89350TaxForm2025Model"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.Mississippi89350TaxForm2025Model"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.Mississippi89350TaxForm2025Model"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.Mississippi89350TaxForm2025Model"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.Mississippi89350TaxForm2025Model"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.Mississippi89350TaxForm2025Model"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.Mississippi89350TaxForm2025Model"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.Mississippi89350TaxForm2025Model"
}
}
}
},
"responses": {
"204": {
"description": "The 89-350 was accepted and processed."
},
"400": {
"description": "The request was invalid; see validation errors for details."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden – the caller lacks required permissions."
},
"404": {
"description": "The employee was not found or is not visible to the caller."
}
}
}
},
"/Employees/{employeeId}/Onboarding/TaxForm/State/Missouri/MOW4/Year/2024": {
"post": {
"tags": [
"Enrollment"
],
"summary": "Submit Missouri MO-W4 (state withholding) – 2024 revision.",
"description": "Submits an Missouri MO-W4 (state withholding) form for the specified employee for the 2024 form revision.\r\nYear/2024 in the route denotes the form’s revision year.\r\n \r\nThe request is validated using data annotations and domain rules. Key validations include:\r\n- Required employee demographic fields and SSN format (xxx-xx-xxxx).\r\n- Missouri filing status selection.\r\n- Validation on Exemptions and Witholding Amounts\r\n \r\nBehavior highlights:\r\n- Filing status is mapped to the appropriate jurisdiction for Missouri.\r\n- Dependents and additional withholding amounts are used to update employee tax setup.\r\n \r\nRoute: POST /Employees/{employeeId}/Onboarding/TaxForm/State/Missouri/MOW4/Year/2024\r\nAuthorization: EMPLOYEETAXFORM_WRITE (Service, ServiceRep)\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employeetaxform-write ````",
"operationId": "EmployeesByEmployeeIdOnboardingTaxFormStateMissouriMOW4Year2024Post",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The employee identifier.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The Missouri MO-W4 (2024 revision) payload for the employee.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MissouriMOW4TaxForm2024Model"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MissouriMOW4TaxForm2024Model"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MissouriMOW4TaxForm2024Model"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MissouriMOW4TaxForm2024Model"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MissouriMOW4TaxForm2024Model"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MissouriMOW4TaxForm2024Model"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MissouriMOW4TaxForm2024Model"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MissouriMOW4TaxForm2024Model"
}
}
}
},
"responses": {
"204": {
"description": "The MO-W4 was accepted and processed."
},
"400": {
"description": "The request was invalid; see validation errors for details."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden – the caller lacks required permissions."
},
"404": {
"description": "The employee was not found or is not visible to the caller."
}
}
}
},
"/Employees/{employeeId}/Onboarding/TaxForm/State/Montana/MW4/Year/2025": {
"post": {
"tags": [
"Enrollment"
],
"summary": "Submit Montana MW-4 (state withholding) – 2025 revision.",
"description": "Submits a Montana MW-4 (Employee's Withholding and Exemption Certificate) form for the specified employee\r\nfor the 2025 form revision. Year/2025 in the route denotes the form's revision year.\r\n \r\nThe request is validated using data annotations and domain rules. Key validations include:\r\n- Required employee demographic fields and SSN format (xxx-xx-xxxx).\r\n- Exactly one filing status must be selected (Line 1a, 1b, or 1c) unless Specified Withholding (Line 4) is provided.\r\n- MarriedBothSpousesWorking (Line 2) is only valid when MarriedFilingJointly (Line 1b) is true.\r\n- Lines 1–3 and Line 4 are mutually exclusive per form instructions.\r\n- Extra withholding and specified withholding amounts must be non-negative and use two decimal places.\r\n \r\nBehavior highlights:\r\n- Filing status is mapped to the appropriate Montana jurisdiction (Single, Married, or Head of Household).\r\n- Married Filing Jointly with Both Spouses Working uses the single withholding rate.\r\n- Exemption checkboxes (Line 5a–5d) determine exempt status and set allowances to 99.\r\n- Extra withholding (Line 3) maps to additional withholding amount.\r\n- Specified withholding (Line 4) maps to the tax amount field.\r\n \r\nRoute: POST /Employees/{employeeId}/Onboarding/TaxForm/State/Montana/MW4/Year/2025\r\nAuthorization: EMPLOYEETAXFORM_WRITE (Service, ServiceRep)\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employeetaxform-write ````",
"operationId": "EmployeesByEmployeeIdOnboardingTaxFormStateMontanaMW4Year2025Post",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The employee identifier.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The Montana MW-4 (2025 revision) payload for the employee.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MontanaMW4TaxForm2025Model"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MontanaMW4TaxForm2025Model"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MontanaMW4TaxForm2025Model"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MontanaMW4TaxForm2025Model"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MontanaMW4TaxForm2025Model"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MontanaMW4TaxForm2025Model"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MontanaMW4TaxForm2025Model"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.MontanaMW4TaxForm2025Model"
}
}
}
},
"responses": {
"204": {
"description": "The MW-4 was accepted and processed."
},
"400": {
"description": "The request was invalid; see validation errors for details."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden – the caller lacks required permissions."
},
"404": {
"description": "The employee was not found or is not visible to the caller."
}
}
}
},
"/Employees/{employeeId}/Onboarding/TaxForm/State/Nebraska/W4N/Year/2022": {
"post": {
"tags": [
"Enrollment"
],
"summary": "Submit Nebraska W-4N - 1-2022 Revision.",
"description": "Submits a Nebraska W-4N form for the specified employee. 1-2022 Revision.\r\nYear/2022 in the route denotes the form's revision year.\r\n \r\nThe request is validated using data annotations and domain rules. Key validations include:\r\n- Required employee demographic fields and SSN format.\r\n- Filing Status must be 1 or 2.\r\n- Additional withholding amounts must be non-negative.\r\n \r\nBehavior highlights:\r\n- Filing status is mapped to the appropriate NE jurisdiction (Single or Married).\r\n- Allowances and additional withholding amounts are used to update employee tax setup.\r\n- On success, this endpoint returns 204 No Content.\r\n \r\nRoute: POST /Employees/{employeeId}/Onboarding/TaxForm/State/Nebraska/W4N/Year/2022\r\nAuthorization: EMPLOYEETAXFORM_WRITE (Service, ServiceRep)\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employeetaxform-write ````",
"operationId": "EmployeesByEmployeeIdOnboardingTaxFormStateNebraskaW4NYear2022Post",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The employee identifier.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The Nebraska W-4N (2022 revision) payload for the employee.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.NebraskaW4NTaxForm2022Model"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.NebraskaW4NTaxForm2022Model"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.NebraskaW4NTaxForm2022Model"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.NebraskaW4NTaxForm2022Model"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.NebraskaW4NTaxForm2022Model"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.NebraskaW4NTaxForm2022Model"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.NebraskaW4NTaxForm2022Model"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.NebraskaW4NTaxForm2022Model"
}
}
}
},
"responses": {
"204": {
"description": "The W-4N was accepted and processed."
},
"400": {
"description": "The request was invalid; see validation errors for details."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden – the caller lacks required permissions."
},
"404": {
"description": "The employee was not found or is not visible to the caller."
}
}
}
},
"/Employees/{employeeId}/Onboarding/TaxForm/State/NewJersey/NJW4/Year/2021": {
"post": {
"tags": [
"Enrollment"
],
"summary": "Submit New Jersey NJ-W4 - 1-2021 Revision.",
"description": "Submits a New Jersey NJ-W4 form for the specified employee. 1-2021 Revision.\r\nYear/2021 in the route denotes the form's revision year.\r\n \r\nThe request is validated using data annotations and domain rules. Key validations include:\r\n- Required employee demographic fields and SSN format.\r\n- Filing Status must be 1-5.\r\n- Wage Chart Letter (Line 3) must be A-E if provided.\r\n- Additional withholding amounts must be non-negative.\r\n \r\nBehavior highlights:\r\n- Filing status and Wage Chart Letter are mapped to the appropriate NJ jurisdiction (Rate A-E).\r\n- Allowances and additional withholding amounts are used to update employee tax setup.\r\n- On success, this endpoint returns 204 No Content.\r\n \r\nRoute: POST /Employees/{employeeId}/Onboarding/TaxForm/State/NewJersey/NJW4/Year/2021\r\nAuthorization: EMPLOYEETAXFORM_WRITE (Service, ServiceRep)\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employeetaxform-write ````",
"operationId": "EmployeesByEmployeeIdOnboardingTaxFormStateNewJerseyNJW4Year2021Post",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The employee identifier.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The New Jersey NJ-W4 (2021 revision) payload for the employee.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.NewJerseyNJW4TaxForm2021Model"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.NewJerseyNJW4TaxForm2021Model"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.NewJerseyNJW4TaxForm2021Model"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.NewJerseyNJW4TaxForm2021Model"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.NewJerseyNJW4TaxForm2021Model"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.NewJerseyNJW4TaxForm2021Model"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.NewJerseyNJW4TaxForm2021Model"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.NewJerseyNJW4TaxForm2021Model"
}
}
}
},
"responses": {
"204": {
"description": "The NJ-W4 was accepted and processed."
},
"400": {
"description": "The request was invalid; see validation errors for details."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden the caller lacks required permissions."
},
"404": {
"description": "The employee was not found or is not visible to the caller."
}
}
}
},
"/Employees/{employeeId}/Onboarding/TaxForm/State/NewYork/IT2104/Year/2026": {
"post": {
"tags": [
"Enrollment"
],
"summary": "Submit New York IT-2104 (state withholding) – 2026 revision.",
"description": "Submits a New York IT-2104 Employee's Withholding Allowance Certificate for the specified employee\r\nfor the 2026 form revision.\r\nYear/2026 in the route denotes the form's revision year.\r\n \r\nThe request is validated using data annotations and New York specific domain rules. Key validations include:\r\n- Required employee demographic fields and SSN format (xxx-xx-xxxx).\r\n- Region must be a valid 2-letter US state code.\r\n- Filing status: exactly one of `SingleOrHeadOfHousehold`, `Married`, or\r\n `MarriedButWithholdAtHigherSingleRate` must be selected.\r\n- Allowance values must be non-negative and within supported ranges.\r\n- Additional withholding amounts must be non-negative and use two decimal places when provided.\r\n \r\nBehavior highlights:\r\n- The request model is mapped to a service model and dispatched to the New York IT-2104 command via MediatR.\r\n- The mapping command determines the New York state jurisdiction based on filing status.\r\n- The handler updates New York state, New York City, and Yonkers tax setup following legacy onboarding rules.\r\n- Nullable additional withholding amounts are normalized to zero before tax onboarding is submitted.\r\n- On success, this endpoint returns 204 No Content.\r\n \r\nRoute: POST /Employees/{employeeId}/Onboarding/TaxForm/State/NewYork/IT2104/Year/2026\r\nAuthorization: EMPLOYEETAXFORM_WRITE (Service, ServiceRep)\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employeetaxform-write ````",
"operationId": "EmployeesByEmployeeIdOnboardingTaxFormStateNewYorkIT2104Year2026Post",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The employee identifier.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The New York IT-2104 (2026 revision) payload for the employee.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.NewYorkIT2104TaxForm2026Model"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.NewYorkIT2104TaxForm2026Model"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.NewYorkIT2104TaxForm2026Model"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.NewYorkIT2104TaxForm2026Model"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.NewYorkIT2104TaxForm2026Model"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.NewYorkIT2104TaxForm2026Model"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.NewYorkIT2104TaxForm2026Model"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.NewYorkIT2104TaxForm2026Model"
}
}
}
},
"responses": {
"204": {
"description": "The IT-2104 was accepted and processed."
},
"400": {
"description": "The request was invalid; see validation errors for details."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden – the caller lacks required permissions."
},
"404": {
"description": "The employee was not found or is not visible to the caller."
}
}
}
},
"/Employees/{employeeId}/Onboarding/TaxForm/State/NewYork/IT2104E/Year/2026": {
"post": {
"tags": [
"Enrollment"
],
"summary": "Submit New York IT-2104-E (certificate of exemption from withholding) – 2026 revision.",
"description": "Submits a New York IT-2104-E Certificate of Exemption from Withholding for the specified employee\r\nfor the 2026 form revision.\r\n \r\nThe request is validated using data annotations and New York specific domain rules. Key validations include:\r\n- Required employee demographic fields and SSN format (xxx-xx-xxxx).\r\n- Region must be a valid 2-letter US state code.\r\n- Filing status: exactly one of `Single`, `Married`, or\r\n `QualifyingSurvivingSpouseOrHeadOfHousehold` must be selected.\r\n \r\nBehavior highlights:\r\n- Single and QualifyingSurvivingSpouseOrHeadOfHousehold both map to NYSINGLE (JurisId 115).\r\n- Married maps to NYMAR (JurisId 114).\r\n- Allowances are hardcoded to 99 (exempt).\r\n- On success, this endpoint returns 204 No Content.\r\n \r\nRoute: POST /Employees/{employeeId}/Onboarding/TaxForm/State/NewYork/IT2104E/Year/2026\r\nAuthorization: EMPLOYEETAXFORM_WRITE (Service, ServiceRep)\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employeetaxform-write ````",
"operationId": "EmployeesByEmployeeIdOnboardingTaxFormStateNewYorkIT2104EYear2026Post",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The employee identifier.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The New York IT-2104-E (2026 revision) payload for the employee.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.NewYorkIT2104ETaxForm2026Model"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.NewYorkIT2104ETaxForm2026Model"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.NewYorkIT2104ETaxForm2026Model"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.NewYorkIT2104ETaxForm2026Model"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.NewYorkIT2104ETaxForm2026Model"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.NewYorkIT2104ETaxForm2026Model"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.NewYorkIT2104ETaxForm2026Model"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.NewYorkIT2104ETaxForm2026Model"
}
}
}
},
"responses": {
"204": {
"description": "The IT-2104-E was accepted and processed."
},
"400": {
"description": "The request was invalid; see validation errors for details."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden – the caller lacks required permissions."
},
"404": {
"description": "The employee was not found or is not visible to the caller."
}
}
}
},
"/Employees/{employeeId}/Onboarding/TaxForm/State/NorthCarolina/NC4/Year/2025": {
"post": {
"tags": [
"Enrollment"
],
"summary": "Submit North Carolina NC-4 (state withholding) – 2025 revision.",
"description": "Submits a North Carolina NC-4 (state withholding) form for the specified employee for the 2025 form revision.\r\nYear/2025 in the route denotes the form’s revision year.\r\n \r\nRequest model and validation:\r\n- Required employee demographics: `FirstName`, `LastName`, and SSN in the format xxx-xx-xxxx (`GovernmentPersonalIdentifier`).\r\n- Required address fields: `Street1`, `Municipality`, `Region` (2-letter code), and `PostalCode` (5-digit or 5+4).\r\n- Filing status: exactly one of the following required booleans must be true (mutually exclusive):\r\n - `SingleOrMarriedFilingSeparately`\r\n - `HeadOfHousehold`\r\n - `MarriedFilingJointlyOrSurvivingSpouse`\r\n- `TotalAllowances` is required and must be in the range 0–99.\r\n- `AdditionalWithholding` is optional; when provided it must be non-negative and expressed with two decimal places.\r\n- Region is validated as a US state code via the shared `StateIsValidRule`.\r\n \r\nBehavior and mapping (via MediatR):\r\n- The API model `NorthCarolinaNC4TaxForm2025Model` is mapped to the service model `NorthCarolinaNC4TaxForm2025` and sent to `NorthCarolinaNC4Command`.\r\n- The command dispatches to `NorthCarolinaNC42025TaxMappingCommand`, which:\r\n - Validates employee visibility via `OriginIsVisibleRule`; returns 404 if not visible.\r\n - Aggregates data-annotation validation errors into a nested validation state.\r\n - Enforces mutual exclusivity of the filing status booleans and presence of `TotalAllowances`.\r\n - Maps filing status to jurisdiction IDs using `StateIncomeTaxJurisdiction`:\r\n - Single or Married Filing Separately → `NCSINGLE`\r\n - Head of Household → `NCHOH`\r\n - Married Filing Jointly or Surviving Spouse → `NCMAR`\r\n - If `Region` is \"NC\", sets `EmployeeTaxRegion` and `EmployeeTaxRegionJurisdictionId` on the root payload.\r\n - Builds `TaxOnboardingCommand` with a single state tax item:\r\n - `EmployeeTaxTaxJurisdictionId` set to the mapped NC jurisdiction.\r\n - `EmployeeTaxAllowances` set to `TotalAllowances`.\r\n - `EmployeeTaxTaxAmount` set to `AdditionalWithholding` when provided; percentage is not used.\r\n- Domain validation exceptions are returned as 400 with details; unknown statuses yield a 501-style error via `NotImplementedException`.\r\n \r\nResponse semantics:\r\n- On success, returns HTTP 204 No Content.\r\n- 400 Bad Request for validation errors; 401 Unauthorized; 403 Forbidden; 404 Not Found (employee not visible).\r\n \r\nRoute: POST /Employees/{employeeId}/Onboarding/TaxForm/State/NorthCarolina/NC4/Year/2025\r\nAuthorization: EMPLOYEETAXFORM_WRITE (Service, ServiceRep)\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employeetaxform-write ````",
"operationId": "EmployeesByEmployeeIdOnboardingTaxFormStateNorthCarolinaNC4Year2025Post",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The employee identifier.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The North Carolina NC-4 (2025 revision) payload for the employee.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.NorthCarolinaNC4TaxForm2025Model"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.NorthCarolinaNC4TaxForm2025Model"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.NorthCarolinaNC4TaxForm2025Model"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.NorthCarolinaNC4TaxForm2025Model"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.NorthCarolinaNC4TaxForm2025Model"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.NorthCarolinaNC4TaxForm2025Model"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.NorthCarolinaNC4TaxForm2025Model"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.NorthCarolinaNC4TaxForm2025Model"
}
}
}
},
"responses": {
"204": {
"description": "The NC-4 was accepted and processed."
},
"400": {
"description": "The request was invalid; see validation errors for details."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden – the caller lacks required permissions."
},
"404": {
"description": "The employee was not found or is not visible to the caller."
}
}
}
},
"/Employees/{employeeId}/Onboarding/TaxForm/State/Ohio/IT4/Year/2024": {
"post": {
"tags": [
"Enrollment"
],
"summary": "Submit Ohio IT 4 (state withholding) – 01/24 revision.",
"description": "Submits an Ohio IT 4 (Employee's Withholding Exemption Certificate) form for the specified employee\r\nfor the 01/24 form revision. Year/2024 in the route denotes the form's revision year.\r\n \r\nThe request is validated using data annotations and domain rules. Key validations include:\r\n- Required employee demographic fields and SSN format (xxx-xx-xxxx).\r\n- Line 1 (personal exemption) must be 0 or 1.\r\n- Line 2 (spousal exemption) must be 0 or 1.\r\n- Number of dependents must be between 0 and 99.\r\n- Additional withholding must be non-negative with up to two decimal places.\r\n- School district number must be greater than 0 when provided and must be a valid Ohio school district.\r\n \r\nSchool district fields:\r\n- `SchoolDistrictNumber` is the Ohio school district number (e.g., 2503 for Columbus City).\r\n Use 9999 for any period the employee was a non-resident of Ohio or in a non-taxing school district.\r\n Callers can look up valid numbers via\r\n `GET /Datalists/TaxJurisdictions/SchoolDistricts?taxRegion=OH` or the Ohio Department of Taxation's\r\n \"The Finder\" tool at https://thefinder.tax.ohio.gov/StreamlineSalesTaxWeb/default_SchoolDistrict.aspx.\r\n- `SchoolDistrictName` is the human-readable district name (e.g., \"Columbus City\") and is stored\r\n for reference only — it does not affect tax calculation.\r\n- When a school district number is provided and resolves to a valid Ohio jurisdiction, a second\r\n employee tax entry is created for the school district with zero additional withholding.\r\n If the number does not resolve to a valid Ohio school district, a 400 validation error is returned.\r\n \r\nBehavior highlights:\r\n- Total withholding exemptions (Line 4) are computed server-side as the sum of Lines 1, 2, and 3.\r\n- Section III waiver checkboxes determine exempt-from-withholding status and set allowances to 99.\r\n- Ohio uses a single tax jurisdiction (OHNA) regardless of filing status.\r\n- EmployeeRoot tax fields are only updated when the employee's region is OH (resident).\r\n \r\nRoute: POST /Employees/{employeeId}/Onboarding/TaxForm/State/Ohio/IT4/Year/2024\r\nAuthorization: EMPLOYEETAXFORM_WRITE (Service, ServiceRep)\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employeetaxform-write ````",
"operationId": "EmployeesByEmployeeIdOnboardingTaxFormStateOhioIT4Year2024Post",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The employee identifier.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The Ohio IT 4 (01/24 revision) payload for the employee.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.OhioIT4TaxForm2024Model"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.OhioIT4TaxForm2024Model"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.OhioIT4TaxForm2024Model"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.OhioIT4TaxForm2024Model"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.OhioIT4TaxForm2024Model"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.OhioIT4TaxForm2024Model"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.OhioIT4TaxForm2024Model"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.OhioIT4TaxForm2024Model"
}
}
}
},
"responses": {
"204": {
"description": "The IT 4 was accepted and processed."
},
"400": {
"description": "The request was invalid; see validation errors for details."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden – the caller lacks required permissions."
},
"404": {
"description": "The employee was not found or is not visible to the caller."
}
}
}
},
"/Employees/{employeeId}/Onboarding/TaxForm/State/Oklahoma/OKW4/Year/2021": {
"post": {
"tags": [
"Enrollment"
],
"summary": "Submit Oklahoma OK-W-4 (state withholding) – 2021 revision.",
"description": "Submits an Oklahoma OK-W-4 (Employee's State Withholding Allowance Certificate) form for the specified employee\r\nfor the 2021 form revision. Year/2021 in the route denotes the form's revision year.\r\n \r\nThe request is validated using data annotations and domain rules. Key validations include:\r\n- Required employee demographic fields and SSN format (xxx-xx-xxxx).\r\n- Exactly one filing status must be selected (Single, Married, or Married but withhold at higher Single rate).\r\n- Lines 1–4 individual allowance values and Line 5 total must be consistent (Line 5 = Lines 1+2+3+4).\r\n- Additional withholding (Line 6) must be non-negative and use two decimal places.\r\n- Exempt flags (Lines 7–9) and additional withholding (Line 6) are mutually exclusive.\r\n \r\nBehavior highlights:\r\n- Filing status is mapped to the appropriate Oklahoma jurisdiction (Single or Married).\r\n- Married but withhold at higher Single rate uses the OKSINGLE jurisdiction with MarriedFilingSingle marital status.\r\n- Exemption checkboxes (Lines 7–9) determine exempt status and set allowances to 99.\r\n- Additional withholding (Line 6) maps to additional withholding amount.\r\n \r\nRoute: POST /Employees/{employeeId}/Onboarding/TaxForm/State/Oklahoma/OKW4/Year/2021\r\nAuthorization: EMPLOYEETAXFORM_WRITE (Service, ServiceRep)\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employeetaxform-write ````",
"operationId": "EmployeesByEmployeeIdOnboardingTaxFormStateOklahomaOKW4Year2021Post",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The employee identifier.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The Oklahoma OK-W-4 (2021 revision) payload for the employee.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.OklahomaOKW4TaxForm2021Model"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.OklahomaOKW4TaxForm2021Model"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.OklahomaOKW4TaxForm2021Model"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.OklahomaOKW4TaxForm2021Model"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.OklahomaOKW4TaxForm2021Model"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.OklahomaOKW4TaxForm2021Model"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.OklahomaOKW4TaxForm2021Model"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.OklahomaOKW4TaxForm2021Model"
}
}
}
},
"responses": {
"204": {
"description": "The OK-W-4 was accepted and processed."
},
"400": {
"description": "The request was invalid; see validation errors for details."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden – the caller lacks required permissions."
},
"404": {
"description": "The employee was not found or is not visible to the caller."
}
}
}
},
"/Employees/{employeeId}/Onboarding/TaxForm/State/Oregon/ORW4/Year/2026": {
"post": {
"tags": [
"Enrollment"
],
"summary": "Submit Oregon OR-W-4 (state withholding) – 2026 revision.",
"description": "Submits an Oregon OR-W-4 (state withholding) form for the specified employee for the 2026 form revision.\r\nYear/2026 in the route denotes the form’s revision year.\r\n \r\nThe request is validated using data annotations and domain rules. Key validations include:\r\n- Required employee demographic fields and SSN format (xxx-xx-xxxx).\r\n- Oregon filing status selection and dependents range.\r\n- Additional withholding amounts must be non-negative and use two decimal places.\r\n \r\nBehavior highlights:\r\n- Filing status is mapped to the appropriate jurisdiction for Oregon.\r\n- Dependents and additional withholding amounts are used to update employee tax setup.\r\n \r\nRoute: POST /Employees/{employeeId}/Onboarding/TaxForm/State/Oregon/ORW4/Year/2026\r\nAuthorization: EMPLOYEETAXFORM_WRITE (Service, ServiceRep)\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employeetaxform-write ````",
"operationId": "EmployeesByEmployeeIdOnboardingTaxFormStateOregonORW4Year2026Post",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The employee identifier.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The Oregon OR-W-4 (2026 revision) payload for the employee.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.OregonORW4TaxForm2026Model"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.OregonORW4TaxForm2026Model"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.OregonORW4TaxForm2026Model"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.OregonORW4TaxForm2026Model"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.OregonORW4TaxForm2026Model"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.OregonORW4TaxForm2026Model"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.OregonORW4TaxForm2026Model"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.OregonORW4TaxForm2026Model"
}
}
}
},
"responses": {
"204": {
"description": "The OR-W-4 was accepted and processed."
},
"400": {
"description": "The request was invalid; see validation errors for details."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden – the caller lacks required permissions."
},
"404": {
"description": "The employee was not found or is not visible to the caller."
}
}
}
},
"/Employees/{employeeId}/Onboarding/TaxForm/State/PuertoRico/499R41/Year/2016": {
"post": {
"tags": [
"Enrollment"
],
"summary": "Submit Puerto Rico Form 499 R-4.1 (state withholding / \"W-4\") – 2016 revision.",
"description": "Submits a Puerto Rico Form 499 R-4.1 (Withholding Exemption Certificate) for the\r\nspecified employee for the 2016 form revision. Form 499 R-4.1 is Puerto Rico's\r\nequivalent of the federal W-4. Year/2016 in the route denotes the form's revision year.\r\n \r\nThe request is validated using data annotations and domain rules. Key validations include:\r\n- Required employee demographic fields and SSN format (xxx-xx-xxxx).\r\n- Region must be a valid 2-letter code; the handler treats this as Puerto Rico-specific logic (PR).\r\n- Personal exemption: exactly one of SingleComplete, SingleNone, MarriedComplete, MarriedHalf, or MarriedNone must be selected.\r\n- Withholding election basis: at most one of `Percentage` or `Amount` may be provided.\r\n- Allowance-based election: at most one of `AllowanceComplete` or `AllowanceNone` may be selected.\r\n- Exempt/allowances rules:\r\n - If `Exempt` is selected, the allowance, exemption, and withholding fields must be zero or empty.\r\n - If `Exempt` is not selected, the exemption/allowance fields drive the withholding computation.\r\n- Additional withholding amounts must be non-negative and use two decimal places when provided.\r\n \r\nBehavior highlights:\r\n- The request model is mapped to a service model and dispatched to the Puerto Rico 499 R-4.1 command via MediatR.\r\n- The 499 R-4.1 mapping sub-command determines the correct Puerto Rico jurisdiction from the personal exemption\r\n election and derives the veteran additional allowance (1 for Complete, otherwise 0), then creates the tax onboarding payload.\r\n- On success, this endpoint returns 204 No Content.\r\n \r\nRoute: POST /Employees/{employeeId}/Onboarding/TaxForm/State/PuertoRico/499R41/Year/2016\r\nAuthorization: EMPLOYEETAXFORM_WRITE (Service, ServiceRep)\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employeetaxform-write ````",
"operationId": "EmployeesByEmployeeIdOnboardingTaxFormStatePuertoRico499R41Year2016Post",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The employee identifier.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The Puerto Rico 499 R-4.1 (2016 revision) payload for the employee.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.PuertoRico499R41TaxForm2016Model"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.PuertoRico499R41TaxForm2016Model"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.PuertoRico499R41TaxForm2016Model"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.PuertoRico499R41TaxForm2016Model"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.PuertoRico499R41TaxForm2016Model"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.PuertoRico499R41TaxForm2016Model"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.PuertoRico499R41TaxForm2016Model"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.PuertoRico499R41TaxForm2016Model"
}
}
}
},
"responses": {
"204": {
"description": "The 499 R-4.1 was accepted and processed."
},
"400": {
"description": "The request was invalid; see validation errors for details."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden – the caller lacks required permissions."
},
"404": {
"description": "The employee was not found or is not visible to the caller."
}
}
}
},
"/Employees/{employeeId}/Onboarding/TaxForm/State/RhodeIsland/RIW4/Year/2025": {
"post": {
"tags": [
"Enrollment"
],
"summary": "Submit Rhode Island RI W-4 (state withholding) – 2025 revision.",
"description": "Submits a Rhode Island RI W-4 (state withholding) form for the specified employee for the 2025 form revision.\r\nYear/2025 in the route denotes the form's revision year.\r\n \r\nThe request is validated using data annotations and domain rules. Key validations include:\r\n- Required employee demographic fields and SSN format (xxx-xx-xxxx).\r\n- Region must be a valid 2-letter US state code.\r\n- If no exemption is claimed, `TotalAllowances` must be provided.\r\n- If `Exempt` is selected, allowances and additional withholding must be zero or empty.\r\n- Total allowances must be between 0 and 10, inclusive.\r\n- Additional withholding amounts must be non-negative and use two decimal places when provided.\r\n \r\nBehavior highlights:\r\n- The request model is mapped to a service model and dispatched to the Rhode Island RI W-4 command via MediatR.\r\n- The Rhode Island W-4 mapping sub-command determines the correct Rhode Island jurisdiction based on spouse \r\n and personal claims and sets allowances (99 if exempt), then creates the tax onboarding payload.\r\n- On success, this endpoint returns 204 No Content.\r\n \r\nRoute: POST /Employees/{employeeId}/Onboarding/TaxForm/State/RhodeIsland/RIW4/Year/2025\r\nAuthorization: EMPLOYEETAXFORM_WRITE (Service, ServiceRep)\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employeetaxform-write ````",
"operationId": "EmployeesByEmployeeIdOnboardingTaxFormStateRhodeIslandRIW4Year2025Post",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The employee identifier.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The Rhode Island RI W-4 (2025 revision) payload for the employee.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.RhodeIslandRIW4TaxForm2025Model"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.RhodeIslandRIW4TaxForm2025Model"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.RhodeIslandRIW4TaxForm2025Model"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.RhodeIslandRIW4TaxForm2025Model"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.RhodeIslandRIW4TaxForm2025Model"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.RhodeIslandRIW4TaxForm2025Model"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.RhodeIslandRIW4TaxForm2025Model"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.RhodeIslandRIW4TaxForm2025Model"
}
}
}
},
"responses": {
"204": {
"description": "The RI W-4 was accepted and processed."
},
"400": {
"description": "The request was invalid; see validation errors for details."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden – the caller lacks required permissions."
},
"404": {
"description": "The employee was not found or is not visible to the caller."
}
}
}
},
"/Employees/{employeeId}/Onboarding/TaxForm/State/SouthCarolina/SCW4/Year/2026": {
"post": {
"tags": [
"Enrollment"
],
"summary": "Submit South Carolina SC-W-4 (state withholding) – 2026 revision.",
"description": "Submits an South Carolina SC-W-4 (state withholding) form for the specified employee for the 2026 form revision.\r\nYear/2026 in the route denotes the form’s revision year.\r\n \r\nThe request is validated using data annotations and domain rules. Key validations include:\r\n- Required employee demographic fields and SSN format (xxx-xx-xxxx).\r\n- South Carolina filing status selection and dependents range.\r\n- Additional withholding amounts must be non-negative and use two decimal places.\r\n \r\nBehavior highlights:\r\n- Filing status is mapped to the appropriate jurisdiction for South Carolina.\r\n- Dependents and additional withholding amounts are used to update employee tax setup.\r\n \r\nRoute: POST /Employees/{employeeId}/Onboarding/TaxForm/State/SouthCarolina/SCW4/Year/2026\r\nAuthorization: EMPLOYEETAXFORM_WRITE (Service, ServiceRep)\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employeetaxform-write ````",
"operationId": "EmployeesByEmployeeIdOnboardingTaxFormStateSouthCarolinaSCW4Year2026Post",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The employee identifier.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The South Carolina SC-W-4 (2026 revision) payload for the employee.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.SouthCarolinaSCW4TaxForm2026Model"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.SouthCarolinaSCW4TaxForm2026Model"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.SouthCarolinaSCW4TaxForm2026Model"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.SouthCarolinaSCW4TaxForm2026Model"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.SouthCarolinaSCW4TaxForm2026Model"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.SouthCarolinaSCW4TaxForm2026Model"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.SouthCarolinaSCW4TaxForm2026Model"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.SouthCarolinaSCW4TaxForm2026Model"
}
}
}
},
"responses": {
"204": {
"description": "The SC-W-4 was accepted and processed."
},
"400": {
"description": "The request was invalid; see validation errors for details."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden – the caller lacks required permissions."
},
"404": {
"description": "The employee was not found or is not visible to the caller."
}
}
}
},
"/Employees/{employeeId}/Onboarding/TaxForm/State/Vermont/W4VT/Year/2018": {
"post": {
"tags": [
"Enrollment"
],
"summary": "Submit Vermont Form W-4VT (state withholding) – 2018 revision.",
"description": "Submits a Vermont Form W-4VT (Employee's Withholding Allowance Certificate) for the specified employee\r\nfor the 2018 form revision (Rev. 12/18). Year/2018 in the route denotes the form's revision year.\r\n \r\nThe request is validated using data annotations and domain rules. Key validations include:\r\n- Required employee demographic fields and SSN format (xxx-xx-xxxx).\r\n- One and only one filing status must be selected.\r\n- Worksheet Lines 1, 2, and 4 must be 0 or 1; Line 3 (Dependents) must be 0-99.\r\n- Line 5 (Total Allowances) must equal Line 1 + Line 2 + Line 3 + Line 4 (unless claiming exempt).\r\n- Line 6 (Additional withholding) must be non-negative and use two decimal places; must be 0 when exempt.\r\n \r\nBehavior highlights:\r\n- Married/Civil Union Filing Jointly maps to Married (VTMAR); all other filing statuses map to Single (VTSINGLE).\r\n- Claiming exempt from withholding sets Allowances to 99 and forces additional withholding to 0.\r\n- Line 5 (Total Allowances) maps to Allowances.\r\n- Line 3 (Dependents) maps to Dependents.\r\n- Line 6 (Additional Withholding) maps to additional withholding amount.\r\n \r\nRoute: POST /Employees/{employeeId}/Onboarding/TaxForm/State/Vermont/W4VT/Year/2018\r\nAuthorization: EMPLOYEETAXFORM_WRITE (Service, ServiceRep)\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employeetaxform-write ````",
"operationId": "EmployeesByEmployeeIdOnboardingTaxFormStateVermontW4VTYear2018Post",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The employee identifier.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The Vermont W-4VT (2018 revision) payload for the employee.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.VermontW4VT2018Model"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.VermontW4VT2018Model"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.VermontW4VT2018Model"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.VermontW4VT2018Model"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.VermontW4VT2018Model"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.VermontW4VT2018Model"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.VermontW4VT2018Model"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.VermontW4VT2018Model"
}
}
}
},
"responses": {
"204": {
"description": "The W-4VT was accepted and processed."
},
"400": {
"description": "The request was invalid; see validation errors for details."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden – the caller lacks required permissions."
},
"404": {
"description": "The employee was not found or is not visible to the caller."
}
}
}
},
"/Employees/{employeeId}/Onboarding/TaxForm/State/Virginia/VA4/Year/2011": {
"post": {
"tags": [
"Enrollment"
],
"summary": "Submit Virginia VA-4 (state withholding) – 2011 revision.",
"description": "Submits a Virginia VA-4 (state withholding) form for the specified employee for the 2011 form revision.\r\nYear/2011 in the route denotes the form's revision year.\r\n\r\nThe request is validated using data annotations and domain rules. Key validations include:\r\n\r\n**Personal Information:**\r\n- Required employee demographic fields: FirstName, LastName, Street1, Municipality, Region (2-char), PostalCode.\r\n- Social Security Number must be in xxx-xx-xxxx format.\r\n- Region must be a valid US state/territory abbreviation.\r\n\r\n**Worksheet Exemptions (Lines 1-8):**\r\n- Personal exemptions:\r\n - ExemptionSelf (Line 1): 0 or 1\r\n - ExemptionSpouse (Line 2): 0 or 1\r\n - ExemptionDependents (Line 3): 0-99\r\n - WorksheetSubtotalPersonalExemptions (Line 4): Must equal sum of Lines 1-3\r\n- Age/Blindness exemptions:\r\n - ExemptionAgeSelf (Line 5a): 0 or 1\r\n - ExemptionAgeSpouse (Line 5b): 0 or 1 (requires ExemptionSpouse = 1)\r\n - ExemptionBlindSelf (Line 6a): 0 or 1 (requires ExemptionSelf = 1)\r\n - ExemptionBlindSpouse (Line 6b): 0 or 1 (requires ExemptionSpouse = 1)\r\n - WorksheetSubtotalAgeBlindExemptions (Line 7): Must equal sum of Lines 5-6\r\n- WorksheetTotalExemptions (Line 8): Must equal Line 4 + Line 7\r\n\r\n**Certificate Fields (Lines 1-4):**\r\n- When NOT exempt (IsExemptFromWithholding = false AND IsMilitarySpouseExempt = false):\r\n - CertificateSubtotalPersonalExemptions (Line 1a): Required; must match Line 4 of worksheet\r\n - CertificateSubtotalAgeBlindExemptions (Line 1b): Required; must match Line 7 of worksheet\r\n - CertificateTotalExemptions (Line 1c): Required; must match Line 8 of worksheet\r\n- When exempt (IsExemptFromWithholding = true OR IsMilitarySpouseExempt = true):\r\n - All certificate fields (Lines 1a, 1b, 1c) must be null\r\n- AdditionalWithholdingAmount (Line 2): Optional; must be ≥ 0 with 2 decimal places\r\n- IsExemptFromWithholding (Line 3): Boolean flag indicating exemption from VA withholding\r\n- IsMilitarySpouseExempt (Line 4): Boolean flag for Military Spouses Residency Relief Act exemption\r\n \r\n**Tax Calculation:**\r\n- When exempt, the system sets allowances to 99 for tax calculation purposes.\r\n- When not exempt, allowances are set to CertificateTotalExemptions value.\r\n- Resident state (Region = \"VA\"): Sets EmployeeTaxRegion to \"VA\" and maps to VANA jurisdiction (146).\r\n- Non-resident: Does not set resident state fields but still creates tax item for VANA jurisdiction.\r\n \r\n**Behavior highlights:**\r\n- The request model is mapped directly to a service model and dispatched to the Virginia VA-4 command via MediatR.\r\n- Domain validation is enforced in the Virginia mapping sub-command, including worksheet calculations and conditional certificate requirements.\r\n- On success, this endpoint returns 204 No Content.\r\n \r\nRoute: POST /Employees/{employeeId}/Onboarding/TaxForm/State/Virginia/VA4/Year/2011\r\nAuthorization: EMPLOYEETAXFORM_WRITE (Service, ServiceRep)\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employeetaxform-write ````",
"operationId": "EmployeesByEmployeeIdOnboardingTaxFormStateVirginiaVA4Year2011Post",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The employee identifier.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The Virginia state VA-4 (2011 revision) payload for the employee.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.VirginiaVA4TaxForm2011Model"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.VirginiaVA4TaxForm2011Model"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.VirginiaVA4TaxForm2011Model"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.VirginiaVA4TaxForm2011Model"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.VirginiaVA4TaxForm2011Model"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.VirginiaVA4TaxForm2011Model"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.VirginiaVA4TaxForm2011Model"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.VirginiaVA4TaxForm2011Model"
}
}
}
},
"responses": {
"204": {
"description": "The VA-4 was accepted and processed."
},
"400": {
"description": "The request was invalid; see validation errors for details."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden – the caller lacks required permissions."
},
"404": {
"description": "The employee was not found or is not visible to the caller."
}
}
}
},
"/Employees/{employeeId}/Onboarding/TaxForm/State/WestVirginia/WVIT104/Year/2023": {
"post": {
"tags": [
"Enrollment"
],
"summary": "Submit West Virginia WV IT-104 (state withholding) – March 2023 revision.",
"description": "Submits a West Virginia WV IT-104 (Employee's Withholding Exemption Certificate) form for the specified employee\r\nfor the March 2023 form revision. Year/2023 in the route denotes the form's revision year.\r\n \r\nThe request is validated using data annotations and domain rules. Key validations include:\r\n- Required employee demographic fields and SSN format (xxx-xx-xxxx).\r\n- Line 1 (Single exemption) must be 0 or 1.\r\n- Line 2 (Married exemptions) must be 0, 1, or 2.\r\n- Line 1 and Line 2 are mutually exclusive (cannot both be greater than 0).\r\n- Line 3 (Dependents) must be 0-99.\r\n- Line 4 (Total Exemptions) must equal Line 1 + Line 2 + Line 3.\r\n- Line 6 (Additional withholding) must be non-negative and use two decimal places.\r\n \r\nBehavior highlights:\r\n- Line 5 (Lower Withholding Rate) overrides jurisdiction to Single (WV1INC) regardless of married status.\r\n- When Line 5 is false and Line 2 > 0, the Married jurisdiction (WV2INC) is used.\r\n- When Line 5 is false and Line 2 = 0, the Single jurisdiction (WV1INC) is used.\r\n- Line 4 (Total Exemptions) maps to Allowances.\r\n- Line 3 (Dependents) maps to Dependents.\r\n- Line 6 (Additional Withholding) maps to additional withholding amount.\r\n \r\nRoute: POST /Employees/{employeeId}/Onboarding/TaxForm/State/WestVirginia/WVIT104/Year/2023\r\nAuthorization: EMPLOYEETAXFORM_WRITE (Service, ServiceRep)\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employeetaxform-write ````",
"operationId": "EmployeesByEmployeeIdOnboardingTaxFormStateWestVirginiaWVIT104Year2023Post",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The employee identifier.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The West Virginia WV IT-104 (March 2023 revision) payload for the employee.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.WestVirginiaWVIT104TaxForm2023Model"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.WestVirginiaWVIT104TaxForm2023Model"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.WestVirginiaWVIT104TaxForm2023Model"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.WestVirginiaWVIT104TaxForm2023Model"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.WestVirginiaWVIT104TaxForm2023Model"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.WestVirginiaWVIT104TaxForm2023Model"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.WestVirginiaWVIT104TaxForm2023Model"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.WestVirginiaWVIT104TaxForm2023Model"
}
}
}
},
"responses": {
"204": {
"description": "The WV IT-104 was accepted and processed."
},
"400": {
"description": "The request was invalid; see validation errors for details."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden – the caller lacks required permissions."
},
"404": {
"description": "The employee was not found or is not visible to the caller."
}
}
}
},
"/Employees/{employeeId}/Onboarding/TaxForm/State/Wisconsin/WT4/Year/2023": {
"post": {
"tags": [
"Enrollment"
],
"summary": "Submit Wisconsin WT-4 (state withholding) – 2023 revision (Form W-204, R. 8-23).",
"description": "Submits a Wisconsin WT-4 (state withholding) form for the specified employee for the 2023 form revision.\r\nYear/2023 in the route denotes the form’s revision year.\r\n \r\nThe request is validated using data annotations and domain rules. Key validations include:\r\n- Required employee demographic fields and SSN format (xxx-xx-xxxx).\r\n- Wisconsin Exemption from Federal and State withholding \r\n- Additional withholding amounts must be non-negative and use two decimal places.\r\n \r\nBehavior highlights:\r\n- Filing status is mapped to the appropriate jurisdiction for Wisconsin.\r\n- Dependents and additional withholding amounts are used to update employee tax setup.\r\n\r\nRoute: POST /Employees/{employeeId}/Onboarding/TaxForm/State/Wisconsin/WT4/Year/2023\r\nAuthorization: EMPLOYEETAXFORM_WRITE (Service, ServiceRep)\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employeetaxform-write ````",
"operationId": "EmployeesByEmployeeIdOnboardingTaxFormStateWisconsinWT4Year2023Post",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The employee identifier.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The Wisconsin WT-4 (2023 revision) payload for the employee.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.WisconsinWT4TaxForm2023Model"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.WisconsinWT4TaxForm2023Model"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.WisconsinWT4TaxForm2023Model"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.WisconsinWT4TaxForm2023Model"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.WisconsinWT4TaxForm2023Model"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.WisconsinWT4TaxForm2023Model"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.WisconsinWT4TaxForm2023Model"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.WisconsinWT4TaxForm2023Model"
}
}
}
},
"responses": {
"204": {
"description": "The WT-4 was accepted and processed."
},
"400": {
"description": "The request was invalid; see validation errors for details."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden – the caller lacks required permissions."
},
"404": {
"description": "The employee was not found or is not visible to the caller."
}
}
}
},
"/Employees/{id}": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Employee Details",
"description": "Gets details about the specified employee.\n \n```` Allows roles: Service, ServiceRep, WebUserEmployee ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Employees.EmployeeDetails.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Employees.EmployeeDetails.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Employees.EmployeeDetails.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Employees.EmployeeDetails.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Employees.EmployeeDetails.Result"
}
}
}
}
}
},
"patch": {
"tags": [
"Employees"
],
"summary": "Patch Employee Basic Information",
"description": "\r\n\r\n Allows for Json patching to be performed against basic employee fields.\r\n More information about PATCHING, see https://developer.ontempworks.com/docs/your-request\r\n \r\n\r\n\r\n Valid Patch paths: /EmployeeId(long), /FirstName(string), /MiddleName(string), /LastName(string), /Alias(string), /NamePrefix(string), /NameSuffix(string), /WashedStatusId(byte), /EmployeeStatusId(string), /IsActive(bool), /EmploymentCategoryId(Guid?), /OrderTypeId(int?), /ContactId(long?), /OrientationGivenDate(DateTime?), /AnniversaryDate(DateTime?), /InterviewDate(DateTime?), /InterviewedBySrIdent(int?), /HowHeardOfId(int?), /HowHeardOfDetail(string), /SchoolDistrictId(int?), /IsExemptFromSchoolDistrictTax(bool), /TaxSchoolDistrictJurisdictionId(int?), /IsExemptFromMunicipalityTax(bool), /MunicipalityId(int?), /TaxMunicipalityJurisdictionId(int?), /IsExemptFromCountyTax(bool), /CountyId(int?), /TaxCountyJurisdictionId(int?), /TaxRegion(string), /TaxRegionJurisdictionId(int?), /PsdCode(string), /FederalExemptions(byte), /Dependents(byte), /IsTaxExempt(bool), (deprecated) /AdditionalTaxWithholding(decimal), /TaxRegionExemptions(byte), /MaritalTaxStatusId(int), /AlternateEmployeeId(string), /SalesTeamId(int?), /LastDate(DateTime?), /ActivationDate(DateTime?), /DeactivationDate(DateTime?), /LicenseClass(string), /IsI9OnFile(bool), /I9ExpirationDate(DateTime?), /JobTitle(string), /IsPayReady(bool), /MailCheck(bool), /EmailPaystubs(bool), /PaycheckDeliveryCode(string), /DefaultPayRate(decimal?), /PayrollNote(string), /Note(string), /PrimaryPhoneNumberContactMethodId(int?), /PrimaryEmailAddressContactMethodId(int?), /PrimaryMessageId(long?), /PastResidences(string), /SecurityClearance(string), /Convictions(string), /IsConvictedFelon(bool?), /NumericRating(int), /ServiceRepId(int), /CompanyId(int?), /WotcEligibilityStatusId(long?), /W4Year(int?), /OtherIncome(decimal?), /ExtraDeductions(decimal?), /DependentAllowance(decimal?), /ExtraWithholding(decimal), /TaxHigher(bool?)\r\n \n \n```` Allows roles: ServiceRep, Service, WebUserEmployee ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdPatch",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "A Json array of patch operations to be performed.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":"John","path":"/FirstName","op":"replace"},{"path":"/MiddleName","op":"remove"},{"value":"SampleMiddleName","path":"/MiddleName","op":"add"},{"path":"/Note","op":"copy","from":"/MiddleName"},{"path":"/Note","op":"move","from":"/MiddleName"},{"value":"John","path":"/FirstName","op":"test"}]
},
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":"John","path":"/FirstName","op":"replace"},{"path":"/MiddleName","op":"remove"},{"value":"SampleMiddleName","path":"/MiddleName","op":"add"},{"path":"/Note","op":"copy","from":"/MiddleName"},{"path":"/Note","op":"move","from":"/MiddleName"},{"value":"John","path":"/FirstName","op":"test"}]
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":"John","path":"/FirstName","op":"replace"},{"path":"/MiddleName","op":"remove"},{"value":"SampleMiddleName","path":"/MiddleName","op":"add"},{"path":"/Note","op":"copy","from":"/MiddleName"},{"path":"/Note","op":"move","from":"/MiddleName"},{"value":"John","path":"/FirstName","op":"test"}]
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":"John","path":"/FirstName","op":"replace"},{"path":"/MiddleName","op":"remove"},{"value":"SampleMiddleName","path":"/MiddleName","op":"add"},{"path":"/Note","op":"copy","from":"/MiddleName"},{"path":"/Note","op":"move","from":"/MiddleName"},{"value":"John","path":"/FirstName","op":"test"}]
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":"John","path":"/FirstName","op":"replace"},{"path":"/MiddleName","op":"remove"},{"value":"SampleMiddleName","path":"/MiddleName","op":"add"},{"path":"/Note","op":"copy","from":"/MiddleName"},{"path":"/Note","op":"move","from":"/MiddleName"},{"value":"John","path":"/FirstName","op":"test"}]
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": "\r\n \r\n \r\n replace\r\n /FirstName\r\n John\r\n \r\n \r\n \r\n remove\r\n /MiddleName\r\n \r\n \r\n \r\n \r\n add\r\n /MiddleName\r\n SampleMiddleName\r\n \r\n \r\n /MiddleName\r\n copy\r\n /Note\r\n \r\n \r\n \r\n /MiddleName\r\n move\r\n /Note\r\n \r\n \r\n \r\n \r\n test\r\n /FirstName\r\n John\r\n \r\n"
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": "\r\n \r\n \r\n replace\r\n /FirstName\r\n John\r\n \r\n \r\n \r\n remove\r\n /MiddleName\r\n \r\n \r\n \r\n \r\n add\r\n /MiddleName\r\n SampleMiddleName\r\n \r\n \r\n /MiddleName\r\n copy\r\n /Note\r\n \r\n \r\n \r\n /MiddleName\r\n move\r\n /Note\r\n \r\n \r\n \r\n \r\n test\r\n /FirstName\r\n John\r\n \r\n"
},
"application/*+xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": "\r\n \r\n \r\n replace\r\n /FirstName\r\n John\r\n \r\n \r\n \r\n remove\r\n /MiddleName\r\n \r\n \r\n \r\n \r\n add\r\n /MiddleName\r\n SampleMiddleName\r\n \r\n \r\n /MiddleName\r\n copy\r\n /Note\r\n \r\n \r\n \r\n /MiddleName\r\n move\r\n /Note\r\n \r\n \r\n \r\n \r\n test\r\n /FirstName\r\n John\r\n \r\n"
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/aca": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Employee ACA Info",
"description": "Get the specified employee's Affordable Care Act (ACA) information. If the ACA information has not been populated this will return no object.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdAcaGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeAcaStatusQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeAcaStatusQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeAcaStatusQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeAcaStatusQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeAcaStatusQuery.Result"
}
}
}
}
}
},
"post": {
"tags": [
"Employees"
],
"summary": "Create ACA Hire",
"description": "Allows you to set the date the employee was hired as well as the employment status - if the employee has not been previously hired without a break in service.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdAcaPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The details of the employee's hiring.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.AcaHireEmployeeRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.AcaHireEmployeeRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.AcaHireEmployeeRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.AcaHireEmployeeRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.AcaHireEmployeeRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.AcaHireEmployeeRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.AcaHireEmployeeRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.AcaHireEmployeeRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created"
}
}
},
"put": {
"tags": [
"Employees"
],
"summary": "Update ACA Employment Status",
"description": "Allows you to specify a new ACA employment status for the employee if the employee is in their administrative period.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdAcaPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The newly evaluated details about the employee's employment.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.AcaUpdateEmployeeStatusRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.AcaUpdateEmployeeStatusRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.AcaUpdateEmployeeStatusRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.AcaUpdateEmployeeStatusRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.AcaUpdateEmployeeStatusRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.AcaUpdateEmployeeStatusRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.AcaUpdateEmployeeStatusRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.AcaUpdateEmployeeStatusRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/aca/metadata": {
"get": {
"tags": [
"Employees"
],
"summary": "Get ACA Meta information",
"description": "Returns information regarding what actions can be taken against an employee's ACA info.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdAcaMetadataGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeAcaMetaQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeAcaMetaQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeAcaMetaQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeAcaMetaQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeAcaMetaQuery.Result"
}
}
}
}
}
}
},
"/Employees/{id}/Accruals": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Accruals",
"description": "Gets a list of accruals for the specified employee.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdAccrualsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of accruals to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of accruals to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "activeOnly",
"in": "query",
"description": "Return accruals that are Active otherwise, return all accruals.",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Accruals.EmployeeAccrualsList.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Accruals.EmployeeAccrualsList.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Accruals.EmployeeAccrualsList.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Accruals.EmployeeAccrualsList.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Accruals.EmployeeAccrualsList.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Accruals.EmployeeAccrualsList.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Accruals.EmployeeAccrualsList.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Employees"
],
"summary": "Create Accrual",
"description": "Creates a new accrual for the specified employee.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdAccrualsPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The accrual to create.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeAccrualRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeAccrualRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeAccrualRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeAccrualRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeAccrualRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeAccrualRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeAccrualRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeAccrualRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.Accruals.CreateEmployeeAccrualCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.Accruals.CreateEmployeeAccrualCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.Accruals.CreateEmployeeAccrualCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.Accruals.CreateEmployeeAccrualCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.Accruals.CreateEmployeeAccrualCommand.Result"
}
}
}
}
}
}
},
"/Employees/{id}/Accruals/{employeeAccrualId}": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Accrual",
"description": "Gets details about an accrual for the specified employee.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdAccrualsByEmployeeAccrualIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "employeeAccrualId",
"in": "path",
"description": "The Id of the employee's accrual.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.Accruals.EmployeeAccrualsList.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.Accruals.EmployeeAccrualsList.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.Accruals.EmployeeAccrualsList.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.Accruals.EmployeeAccrualsList.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.Accruals.EmployeeAccrualsList.Result"
}
}
}
}
}
},
"put": {
"tags": [
"Employees"
],
"summary": "Update Accrual",
"description": "Updates an accrual for the specified employee.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdAccrualsByEmployeeAccrualIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "employeeAccrualId",
"in": "path",
"description": "The Id of the employee's accrual.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The accrual to update.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeAccrualRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeAccrualRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeAccrualRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeAccrualRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeAccrualRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeAccrualRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeAccrualRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeAccrualRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/accruals/{employeeAccrualId}/history": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Accrual history",
"description": "Gets history about an accrual for the specified employee.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdAccrualsByEmployeeAccrualIdHistoryGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "employeeAccrualId",
"in": "path",
"description": "The Id of an employee accrual that the list should be filtered by.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "WeekendStartDate",
"in": "query",
"description": "The start date of the weekend that the accrual history should be filtered by.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "WeekendEndDate",
"in": "query",
"description": "The start date of the weekend that the accrual history should be filtered by.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "OrderBy",
"in": "query",
"description": "Used to order the results by one of the returned columns. The system sorts by accrual name by default.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "OrderByAscending",
"in": "query",
"description": "Used to specify the sort order. If left null, the system will order ascending automatically.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "Skip",
"in": "query",
"description": "Amount of list items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Take",
"in": "query",
"description": "Amount of list items to take. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Accruals.EmployeeAccrualHistoryList.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Accruals.EmployeeAccrualHistoryList.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Accruals.EmployeeAccrualHistoryList.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Accruals.EmployeeAccrualHistoryList.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Accruals.EmployeeAccrualHistoryList.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Accruals.EmployeeAccrualHistoryList.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Accruals.EmployeeAccrualHistoryList.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Employees/{id}/accruals/{employeeAccrualId}/manualAccrual": {
"post": {
"tags": [
"Employees"
],
"summary": "Create a manual employee accrual item.",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdAccrualsByEmployeeAccrualIdManualAccrualPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Id of the Employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "employeeAccrualId",
"in": "path",
"description": "Id of the employee accrual to add a manual adjustment to.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "Request body containing information about the manual accrual adjustment.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.InsertManualAccrualRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.InsertManualAccrualRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.InsertManualAccrualRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.InsertManualAccrualRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.InsertManualAccrualRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.InsertManualAccrualRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.InsertManualAccrualRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.InsertManualAccrualRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.Accruals.InsertManualEmployeeAccrual.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.Accruals.InsertManualEmployeeAccrual.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.Accruals.InsertManualEmployeeAccrual.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.Accruals.InsertManualEmployeeAccrual.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.Accruals.InsertManualEmployeeAccrual.Result"
}
}
}
}
}
}
},
"/Employees/{id}/accruals/{employeeAccrualId}/previewManualAccrual": {
"post": {
"tags": [
"Employees"
],
"summary": "Preview how a manual adjustment would effect the employee's accrual balances. This does not change the employee's balances \r\nand does not create a manual adjustment or modify any existing data.",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdAccrualsByEmployeeAccrualIdPreviewManualAccrualPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Id of the Employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "employeeAccrualId",
"in": "path",
"description": "Id of the employee accrual to add a manual adjustment to.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "Request body containing information about the manual accrual adjustment.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.InsertManualAccrualRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.InsertManualAccrualRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.InsertManualAccrualRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.InsertManualAccrualRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.InsertManualAccrualRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.InsertManualAccrualRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.InsertManualAccrualRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.InsertManualAccrualRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.Accruals.PreviewManualEmployeeAccrual.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.Accruals.PreviewManualEmployeeAccrual.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.Accruals.PreviewManualEmployeeAccrual.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.Accruals.PreviewManualEmployeeAccrual.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.Accruals.PreviewManualEmployeeAccrual.Result"
}
}
}
}
}
}
},
"/Employees/{id}/Accruals/Balances": {
"get": {
"tags": [
"Employees"
],
"summary": "Get accrual balances for the specified employee.",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdAccrualsBalancesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of accruals to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of accruals to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "activeOnly",
"in": "query",
"description": "Return accruals that are Active otherwise, return all accruals.",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Accruals.EmployeeAccrualBalanceList.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Accruals.EmployeeAccrualBalanceList.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Accruals.EmployeeAccrualBalanceList.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Accruals.EmployeeAccrualBalanceList.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Accruals.EmployeeAccrualBalanceList.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Accruals.EmployeeAccrualBalanceList.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Accruals.EmployeeAccrualBalanceList.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Employees/{id}/Accruals/Balances/{employeeAccrualId}": {
"get": {
"tags": [
"Employees"
],
"summary": "Get accrual balance for the specified employee accrual.",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdAccrualsBalancesByEmployeeAccrualIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "employeeAccrualId",
"in": "path",
"description": "The Id of the employee's accrual.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.Accruals.EmployeeAccrualBalanceList.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.Accruals.EmployeeAccrualBalanceList.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.Accruals.EmployeeAccrualBalanceList.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.Accruals.EmployeeAccrualBalanceList.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.Accruals.EmployeeAccrualBalanceList.Result"
}
}
}
}
}
}
},
"/Employees/{id}/address": {
"put": {
"tags": [
"Employees"
],
"summary": "Update Address",
"description": "Updates the specified employee's address. If the address is in the United States, the system will validate it against the address\r\nstandardization service. This validation can be bypassed by setting BypassAddressValidationService to true.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdAddressPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The request body containing the updated address values.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeAddressRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeAddressRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeAddressRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeAddressRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeAddressRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeAddressRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeAddressRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeAddressRequest"
}
}
}
},
"responses": {
"200": {
"description": "A list of potential endpoints to refetch if you use caching. This list does not always contain values.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.LinksResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.LinksResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.LinksResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.LinksResponse"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.LinksResponse"
}
}
}
},
"520": {
"description": "The address standardization service is encountering server issues. Try again later."
},
"521": {
"description": "The address standardization service is encountering issues with the request."
}
}
}
},
"/Employees/{id}/addresses": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Address",
"description": "Gets the address and temporary mailing address of the specified employee\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdAddressesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "The address and temporary mailing address of the specified employee",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeAddressQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeAddressQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeAddressQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeAddressQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeAddressQuery.Result"
}
}
}
}
}
}
},
"/Employees/{id}/adjustments": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Adjustment List",
"description": "Gets a list of adjustments for the employee. The list is sorted by adjustment name.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdAdjustmentsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of adjustments to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of adjustments to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Adjustments.EmployeeAdjustmentsQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Adjustments.EmployeeAdjustmentsQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Adjustments.EmployeeAdjustmentsQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Adjustments.EmployeeAdjustmentsQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Adjustments.EmployeeAdjustmentsQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Adjustments.EmployeeAdjustmentsQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Adjustments.EmployeeAdjustmentsQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Employees"
],
"summary": "Create Adjustment",
"description": "Creates an adjustment for the specified employee.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdAdjustmentsPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The values for the new adjustment passed through the request body.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeAdjustmentRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeAdjustmentRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeAdjustmentRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeAdjustmentRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeAdjustmentRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeAdjustmentRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeAdjustmentRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeAdjustmentRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Adjustments.CreateEmployeeAdjustmentCommand.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Adjustments.CreateEmployeeAdjustmentCommand.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Adjustments.CreateEmployeeAdjustmentCommand.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Adjustments.CreateEmployeeAdjustmentCommand.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Adjustments.CreateEmployeeAdjustmentCommand.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Adjustments.CreateEmployeeAdjustmentCommand.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Adjustments.CreateEmployeeAdjustmentCommand.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Employees/{id}/adjustments/{employeeAdjustmentId}": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Adjustment Details",
"description": "Gets the details of the specified adjustment.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdAdjustmentsByEmployeeAdjustmentIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "employeeAdjustmentId",
"in": "path",
"description": "The Id of the employee adjustment",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Adjustments.EmployeeAdjustmentDetailsQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Adjustments.EmployeeAdjustmentDetailsQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Adjustments.EmployeeAdjustmentDetailsQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Adjustments.EmployeeAdjustmentDetailsQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Adjustments.EmployeeAdjustmentDetailsQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Adjustments.EmployeeAdjustmentDetailsQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Adjustments.EmployeeAdjustmentDetailsQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"put": {
"tags": [
"Employees"
],
"summary": "Update Adjustment",
"description": "Updates the specified adjustment for the specified employee.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdAdjustmentsByEmployeeAdjustmentIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "employeeAdjustmentId",
"in": "path",
"description": "The Id of the employee adjustment",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The new values for the adjustment passed through the request body.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeAdjustmentRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeAdjustmentRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeAdjustmentRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeAdjustmentRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeAdjustmentRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeAdjustmentRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeAdjustmentRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeAdjustmentRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
},
"delete": {
"tags": [
"Employees"
],
"summary": "Delete Adjustment",
"description": "Deletes the specified adjustment.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdAdjustmentsByEmployeeAdjustmentIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "employeeAdjustmentId",
"in": "path",
"description": "The Id of the employee adjustment",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/announcements": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Announcement List",
"description": "Gets a list of Web Announcements for the employee. The list is sorted by with the most recent Announcement first. \r\n Announcements are Messages with an Action of WebToEmployees, WebToAllEmployees, or WebMessage. If the employee does not\r\n have a Web Account, a 403 Forbidden response will be returned.\n \n```` Allows roles: ServiceRep, Service, WebUserEmployee ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdAnnouncementsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of assignments to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of assignments to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "limitToUnreadAnnouncements",
"in": "query",
"description": "If set to true only announcements not marked as read will be returned.",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeWebAnnouncementListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeWebAnnouncementListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeWebAnnouncementListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeWebAnnouncementListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeWebAnnouncementListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeWebAnnouncementListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeWebAnnouncementListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Employees/{id}/announcements/{messageId}/markAsRead": {
"put": {
"tags": [
"Employees"
],
"summary": "Get Announcement List",
"description": "Marks an Announcement as having been read by the Employee. If the employee does not have a Web Account, a 403 Forbidden response\r\nwill be returned.\n \n```` Allows roles: WebUserEmployee ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdAnnouncementsByMessageIdMarkAsReadPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "messageId",
"in": "path",
"description": "The message Id of the Announcement.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/AssessmentSessions": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Assessment Sessions",
"description": "Get a list of assessment sessions assigned to the specified employee.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "EmployeesByIdAssessmentSessionsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "assessmentVendorId",
"in": "query",
"description": "Optional filter on the assessment vendor.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "vendorSessionId",
"in": "query",
"description": "Optional filter on the vendor supplied sessionId.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "assessmentSessionId",
"in": "query",
"description": "Optional filter on the unique identifier of the assessment session.",
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "isComplete",
"in": "query",
"description": "Optional filter on the complete status of the assessment session.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "isActive",
"in": "query",
"description": "Optional filter on the active status of the assessment session. Sessions that are canceled or expired will be inactive.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of assessment sessions to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of assessment sessions to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.AssessmentSessionsQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.AssessmentSessionsQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.AssessmentSessionsQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.AssessmentSessionsQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.AssessmentSessionsQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.AssessmentSessionsQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.AssessmentSessionsQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Employees"
],
"summary": "Create Assessment Sessions",
"description": "Creates assessment sessions for the specified employee. Since sessions are created independently there is an opportunity for some of the requested sessions to be created and some to fail.\r\n You must evaluate the response to determine which failed and which succeeded. As of 8/17/2017 it is recommended that failed sessions are simply retried since sessions will not duplicate if they are not started by the user.\r\n Note that the user may still receive an email alert if any sessions are successful.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "EmployeesByIdAssessmentSessionsPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The request object used to generate the session.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.API.Models.CreateAssessmentSessionRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.API.Models.CreateAssessmentSessionRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.API.Models.CreateAssessmentSessionRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.API.Models.CreateAssessmentSessionRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.API.Models.CreateAssessmentSessionRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.API.Models.CreateAssessmentSessionRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.API.Models.CreateAssessmentSessionRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.API.Models.CreateAssessmentSessionRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.CreateAssessmentSessionsCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.CreateAssessmentSessionsCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.CreateAssessmentSessionsCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.CreateAssessmentSessionsCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.CreateAssessmentSessionsCommand.Result"
}
}
}
}
}
}
},
"/Employees/{id}/AssessmentSessions/{assessmentSessionId}/updateResults": {
"post": {
"tags": [
"Employees"
],
"summary": "Refresh Assessment Session Results",
"description": "Will request that the results for an assessment session be updated by the vendor. Use this if the automatic posting of results failed and a refresh is needed.\r\n Review the results for information regarding the update. Update requests to completed sessions and updates with no changes will be ignored and noted in the response.",
"operationId": "EmployeesByIdAssessmentSessionsByAssessmentSessionIdUpdateResultsPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "assessmentSessionId",
"in": "path",
"description": "The Id of the assessment session.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.UpdateAssessmentSessionResultsCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.UpdateAssessmentSessionResultsCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.UpdateAssessmentSessionResultsCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.UpdateAssessmentSessionResultsCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.UpdateAssessmentSessionResultsCommand.Result"
}
}
}
}
}
}
},
"/Employees/{id}/AssessmentSessions/{assessmentSessionId}/updateStatus": {
"post": {
"tags": [
"Employees"
],
"summary": "Refresh Assessment Session Status",
"description": "Will request that the status for an assessment session be updated by the vendor. Use this if the automatic updates of the session status failed and a refresh is needed. \r\n Review the results for information regarding the update. Update requests to completed sessions and updates with no changes will be ignored and noted in the response.",
"operationId": "EmployeesByIdAssessmentSessionsByAssessmentSessionIdUpdateStatusPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "assessmentSessionId",
"in": "path",
"description": "The Id of the assessment session.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "updateResultsIfComplete",
"in": "query",
"description": "When true, the system will attempt to update the results of the assessment if the assessment is complete. Defaults to true.",
"style": "form",
"schema": {
"type": "boolean",
"default": true
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.UpdateAssessmentSessionStatusCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.UpdateAssessmentSessionStatusCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.UpdateAssessmentSessionStatusCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.UpdateAssessmentSessionStatusCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.UpdateAssessmentSessionStatusCommand.Result"
}
}
}
}
}
}
},
"/Employees/{id}/AssessmentSessions/FormFields": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Assessment Session Request Form Fields",
"description": "Get the populated form fields to pass as overrides to the default values during the creation of a new session. The values included are the default values for the employee specified.\r\nIf changes are needed, update the values and pass as the SessionRequestOverrides property during the creation of assessment sessions.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "EmployeesByIdAssessmentSessionsFormFieldsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.AssessmentSessionFormFieldsQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.AssessmentSessionFormFieldsQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.AssessmentSessionFormFieldsQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.AssessmentSessionFormFieldsQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.AssessmentSessionFormFieldsQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.AssessmentSessionFormFieldsQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.AssessmentSessionFormFieldsQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Employees/{id}/assignments": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Assignment List",
"description": "Gets a list of assignments for the employee. The list is sorted by showing those that are still open and started most recently to those that closed the longest time ago.\n \n```` Allows roles: Service, ServiceRep, WebUserEmployee ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdAssignmentsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "Skip",
"in": "query",
"description": "The number of assignments to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Take",
"in": "query",
"description": "The number of assignments to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "IsActive",
"in": "query",
"description": "Searches for assignments that are active or inactive based upon the provided value. Leave null to return all.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "IsDeleted",
"in": "query",
"description": "Searches for assignments that have or have not been marked as deleted by a service representative. Leave null to return all.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "StartDate",
"in": "query",
"description": "An optional parameter. Only assignments for which the employee was working during or after\r\nthe specified date will be returned.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "EndDate",
"in": "query",
"description": "An optional parameter. Only assignments for which the employee was working during or before\r\nthe specified date will be returned.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "CanGenerateTimecard",
"in": "query",
"description": "Optional filter which limits the list of assignments to those which can generate a timecard or not.\r\nDo not specify a value to return all",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "OrderBy",
"in": "query",
"description": "Used to order the results by one of the returned columns.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "OrderByAscending",
"in": "query",
"description": "Used to specify the sort order. If left null, the system will order ascending automatically.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "AssignmentStatusId",
"in": "query",
"description": "Optional filter for assignment status Id. Ref: /datalists/assignmentStatuses",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Culture",
"in": "query",
"description": "Optional filter to return the translated texts in the given culture.",
"style": "form",
"schema": {
"maxLength": 20,
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Assignments.AssignmentSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Assignments.AssignmentSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Assignments.AssignmentSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Assignments.AssignmentSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Assignments.AssignmentSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Assignments.AssignmentSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Assignments.AssignmentSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Employees/{id}/assignments/{assignmentId}/webtimecards/metadata": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Web Timecard Metadata for Assignment",
"description": "Returns metadata for use in generating a web timecard for an employee's assignment.\n \n```` Allows roles: ServiceRep, WebUserEmployee ````\n \n```` Requires scope(s): webtimecard-read or webtimecard-write ````",
"operationId": "EmployeesByIdAssignmentsByAssignmentIdWebtimecardsMetadataGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "assignmentId",
"in": "path",
"description": "Filters web timecards to a specific assignment",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "WorkDate",
"in": "query",
"description": "If supplied, the results will include the period start and end dates, and weekend date.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "LimitSuggestedCostCenters",
"in": "query",
"description": "When true, only the cost centers used on the customer of the assignment are returned. \r\nWhen false, all cost centers previously used by the employee are returned.\r\nDefaults to true.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "PayCodeId",
"in": "query",
"description": "Optional parameter. The system will additionally check for duplicates when both PayCodeId and WorkDate are supplied.\r\nIf the system is configured to not allow duplicates, then the system will check for duplication based upon the combination of assignment Id, pay rate, paycodeId, cost center and weekend date.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "CostCenter",
"in": "query",
"description": "The system will additionally check for duplicates using the CostCenter value when PayCodeId and WorkDate are supplied.\r\nIf the system is configured to not allow duplicates, then the system will check for duplication based upon the combination of assignment Id, pay rate, paycodeId, cost center and weekend date.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "PayRate",
"in": "query",
"description": "Optional parameter. The system will additionally check for duplicates using the PayRate when PayCodeId and WorkDate are supplied.\r\nIf the pay rate is not supplied, the pay rate of the assignment will be used.\r\nIf the system is configured to not allow duplicates, then the system will check for duplication based upon the combination of assignment Id, pay rate, paycodeId, cost center and weekend date.",
"style": "form",
"schema": {
"type": "number",
"format": "double"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardAssignmentMetadata.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardAssignmentMetadata.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardAssignmentMetadata.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardAssignmentMetadata.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardAssignmentMetadata.Result"
}
}
}
}
}
}
},
"/Employees/{id}/assignments/webtimecards": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Employee Web Timecards Grouped By Assignment and Week End",
"description": "Returns web timecards for an employee grouped by the assignment and the week end date.\n \n```` Allows roles: ServiceRep, WebUserEmployee ````\n \n```` Requires scope(s): webtimecard-read or webtimecard-write ````",
"operationId": "EmployeesByIdAssignmentsWebtimecardsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "AssignmentId",
"in": "query",
"description": "Filters web timecards to a specific assignment Id.",
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "Startdate",
"in": "query",
"description": "Filter on timecards which contain a date worked after or on the start date.\r\nA date worked is any day between the timecards period start date and period end date.\r\nWhen null, all timecards with a start date prior to the end date are included.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "Enddate",
"in": "query",
"description": "Filter on timecards which contain a date worked prior to or on the end date.\r\nA date worked is any day between the timecards period start date and period end date.\r\nWhen null, all timecards with an end date after the start date are included.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "WebTimecardStatusIds",
"in": "query",
"description": "The webTimecardStatusIds to filter on. If no values are supplied, then all timecard statuses are returned. For valid values reference the WebTimecardStatus Datalist. ref: datalists/webtimecardstatuses",
"style": "form",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
{
"name": "Orderby",
"in": "query",
"description": "Order the results by jobTitle or date. Valid values are 'jobtitle' and 'date'.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "OrderByAscending",
"in": "query",
"description": "Specifies the order by direction. When ordering by jobtitle, the ordering will be done by jobTitle and orderByAscending value, then weekend date descending.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "Skip",
"in": "query",
"description": "The number of items to skip. Used in paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Take",
"in": "query",
"description": "The number of items to take. Used in paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Culture",
"in": "query",
"description": "Optional filter to return the translated texts in the given culture.",
"style": "form",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardListGroupedByAssignmentAndWeekend.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardListGroupedByAssignmentAndWeekend.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardListGroupedByAssignmentAndWeekend.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardListGroupedByAssignmentAndWeekend.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardListGroupedByAssignmentAndWeekend.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardListGroupedByAssignmentAndWeekend.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardListGroupedByAssignmentAndWeekend.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Employees/{id}/availability": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Availability List",
"description": "Gets a list of availability entries for the employee. The list is sorted by showing the entries that started earliest first.\n \n```` Allows roles: ServiceRep, WebUserEmployee, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdAvailabilityGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of availability records to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of availability records to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "startDate",
"in": "query",
"description": "An optional paramemter. Only availability records on or after \r\nthe specified date will be returned.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "endDate",
"in": "query",
"description": "An optional paramemter. Only availability records on or before \r\nthe specified date will be returned.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeAvailabilityListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeAvailabilityListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeAvailabilityListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeAvailabilityListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeAvailabilityListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeAvailabilityListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeAvailabilityListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Employees"
],
"summary": "Create Employee Availability Record",
"description": "Creates an employee availability record for the given day.\r\nThis can be used to overwrite a recurrence record for a day.\n \n```` Allows roles: ServiceRep, WebUserEmployee, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdAvailabilityPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The body of the request containing the information to create the availability record",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeAvailability"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeAvailability"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeAvailability"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeAvailability"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeAvailability"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeAvailability"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeAvailability"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeAvailability"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.CreateEmployeeAvailabilityCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.CreateEmployeeAvailabilityCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.CreateEmployeeAvailabilityCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.CreateEmployeeAvailabilityCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.CreateEmployeeAvailabilityCommand.Result"
}
}
}
}
}
}
},
"/Employees/{id}/availability/{employeeAvailabilityId}": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Employee Availability Record",
"description": "Gets a single employee availability record with the given availabilityId.\r\nIf the recurrenceId is included and not null in the result, then this record is part of a recurring availability.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdAvailabilityByEmployeeAvailabilityIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "employeeAvailabilityId",
"in": "path",
"description": "The Id of the employee availability record",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeAvailabilityQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeAvailabilityQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeAvailabilityQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeAvailabilityQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeAvailabilityQuery.Result"
}
}
}
}
}
},
"put": {
"tags": [
"Employees"
],
"summary": "Update Employee Availability Record",
"description": "Updates the availability record with the given employeeAvailabilityId - replacing the existing contents.\r\nIf the availability record is part of a recurrence, it will be removed from the recurrence during the update.\n \n```` Allows roles: ServiceRep, WebUserEmployee, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdAvailabilityByEmployeeAvailabilityIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "employeeAvailabilityId",
"in": "path",
"description": "The Id of the availability record to update",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The body of the request containing the information to update the availability record",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeAvailability"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeAvailability"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeAvailability"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeAvailability"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeAvailability"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeAvailability"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeAvailability"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeAvailability"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
},
"delete": {
"tags": [
"Employees"
],
"summary": "Delete Employee Availability Record",
"description": "Deletes the availability record with the given employeeAvailabilityId.\r\nDeletes are not supported for availability records that are part of a recurrence.\r\nOverride a single record out of a recurrence by modifying the single record with a new status rather than deleting it.\n \n```` Allows roles: ServiceRep, Service, WebUserEmployee ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdAvailabilityByEmployeeAvailabilityIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "employeeAvailabilityId",
"in": "path",
"description": "The Id of the availability record to delete",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/availability/recurrence": {
"post": {
"tags": [
"Employees"
],
"summary": "Create Recurring Employee Availability Record.\r\nThis will create the recurrence and will also populate the recurrence by creating individual records for each affected day.",
"description": "Creates an employee availability record with simple recurrence.\n \n```` Allows roles: ServiceRep, WebUserEmployee, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdAvailabilityRecurrencePost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The body of the request containing the information to create the recurrring availability records",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeAvailabilityRecurrence"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeAvailabilityRecurrence"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeAvailabilityRecurrence"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeAvailabilityRecurrence"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeAvailabilityRecurrence"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeAvailabilityRecurrence"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeAvailabilityRecurrence"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeAvailabilityRecurrence"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.CreateEmployeeAvailabilityCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.CreateEmployeeAvailabilityCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.CreateEmployeeAvailabilityCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.CreateEmployeeAvailabilityCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.CreateEmployeeAvailabilityCommand.Result"
}
}
}
}
}
}
},
"/Employees/{id}/availability/recurrence/{recurrenceId}": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Recurring Employee Availability Record",
"description": "Gets a single recurring employee availability record with the given recurrenceId.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdAvailabilityRecurrenceByRecurrenceIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "recurrenceId",
"in": "path",
"description": "The Id of the recurring employee availability record",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeAvailabilityRecurrenceQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeAvailabilityRecurrenceQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeAvailabilityRecurrenceQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeAvailabilityRecurrenceQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeAvailabilityRecurrenceQuery.Result"
}
}
}
}
}
},
"put": {
"tags": [
"Employees"
],
"summary": "Update Recurring Employee Availability Record",
"description": "Updates the recurring availability record with the given recurrenceId - replacing the existing contents and recreating the individual availability records.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdAvailabilityRecurrenceByRecurrenceIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "recurrenceId",
"in": "path",
"description": "The Id of the recurring availability record to update",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The body of the request containing the information to update the recurring availability record",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeAvailabilityRecurrence"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeAvailabilityRecurrence"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeAvailabilityRecurrence"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeAvailabilityRecurrence"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeAvailabilityRecurrence"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeAvailabilityRecurrence"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeAvailabilityRecurrence"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeAvailabilityRecurrence"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
},
"delete": {
"tags": [
"Employees"
],
"summary": "Delete Recurring Employee Availability Record",
"description": "Deletes the recurring availability with the given recurrenceId.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdAvailabilityRecurrenceByRecurrenceIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "recurrenceId",
"in": "path",
"description": "The Id of the recurring availability record to delete",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/Background": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Background Information",
"description": "Gets background information about the specified employee.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdBackgroundGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeBackgroundQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeBackgroundQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeBackgroundQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeBackgroundQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeBackgroundQuery.Result"
}
}
}
}
}
}
},
"/Employees/{id}/backgroundChecks": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Employee Background Checks",
"description": "Returns the list of background checks for an employee ordered by the DateCreated desc.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): backgroundcheck-read or backgroundcheck-write ````",
"operationId": "EmployeesByIdBackgroundChecksGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "BackgroundCheckId",
"in": "query",
"description": "Optional filter on the Id of the background check.",
"style": "form",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "BackgroundCheckVendorId",
"in": "query",
"description": "Optional filter on the Id of background check vendor.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "BackgroundCheckStatusId",
"in": "query",
"description": "Optional filter on the background check status.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "CreatedByServiceRepId",
"in": "query",
"description": "Optional filter on the Id of the service rep who created the background check request.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "IsReviewed",
"in": "query",
"description": "Optional filter used to filter out background checks which are reviewed.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "OrderBy",
"in": "query",
"description": "Criteria to allow for the control of the Order by Column. Use the column name of the results to locate available fields.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "OrderByAscending",
"in": "query",
"description": "Criteria to allow for the direction of the Order by Column.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "Skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Take",
"in": "query",
"description": "The number of items to take. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.BackgroundChecks.BackgroundChecksSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.BackgroundChecks.BackgroundChecksSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.BackgroundChecks.BackgroundChecksSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.BackgroundChecks.BackgroundChecksSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.BackgroundChecks.BackgroundChecksSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.BackgroundChecks.BackgroundChecksSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.BackgroundChecks.BackgroundChecksSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Employees/{id}/backgroundChecks/metadata": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Employee Background Checks Metadata",
"description": "Returns the employee background checks metadata.\r\nThis endpoint will be used to return more information about the employee background checks in the future.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdBackgroundChecksMetadataGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.BackgroundChecksMetadata.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.BackgroundChecksMetadata.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.BackgroundChecksMetadata.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.BackgroundChecksMetadata.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.BackgroundChecksMetadata.Result"
}
}
}
}
}
}
},
"/Employees/{id}/backgroundChecks/profile": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Employee Profile",
"description": "Returns the employee profile containing the data which will be used to create background checks.\r\nThe exact data used will be based upon vendor and package requirements. This only represents the source data to be sent.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): backgroundcheck-read or backgroundcheck-write ````",
"operationId": "EmployeesByIdBackgroundChecksProfileGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "IncludeWorkHistory",
"in": "query",
"description": "When true, work history will be included. \r\nDefaults to false.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "IncludeReferences",
"in": "query",
"description": "When true, references will be included. \r\nDefaults to false.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "IncludeEducationHistory",
"in": "query",
"description": "When true, education history will be included. \r\nDefaults to false.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "IncludeDriversLicense",
"in": "query",
"description": "When true, Drivers License details will be included. \r\nDefaults to false.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "IncludeBackgroundCheckIdentifiers",
"in": "query",
"description": "When true, includes a list of identifiers and properties specific to Background Check Vendors.\r\nDefaults to false.",
"style": "form",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.BackgroundChecks.EmployeeProfile"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.BackgroundChecks.EmployeeProfile"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.BackgroundChecks.EmployeeProfile"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.BackgroundChecks.EmployeeProfile"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.BackgroundChecks.EmployeeProfile"
}
}
}
}
}
}
},
"/Employees/{id}/BasicTaxSetup/{countryCode}": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Basic Tax Setup",
"description": "Gets basic tax setup information for the specified employee.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdBasicTaxSetupByCountryCodeGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "countryCode",
"in": "path",
"description": "The country code of the country whose tax setup information to return. If not provided, this defaults to 840 for UnitedStates. Only the country code 840 is currently supported.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32",
"default": 840
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeBasicTaxSetupQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeBasicTaxSetupQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeBasicTaxSetupQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeBasicTaxSetupQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeBasicTaxSetupQuery.Result"
}
}
}
}
}
}
},
"/Employees/{id}/BasicTaxSetup/{countryCode}/metadata": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Basic Tax Setup Metadata",
"description": "Gets basic tax setup metadata for the specified employee.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdBasicTaxSetupByCountryCodeMetadataGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "countryCode",
"in": "path",
"description": "The country code of the country whose tax setup information to return. If not provided, this defaults to 840 for UnitedStates. Only the country code 840 is currently supported.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeBasicTaxSetupMetadataQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeBasicTaxSetupMetadataQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeBasicTaxSetupMetadataQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeBasicTaxSetupMetadataQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeBasicTaxSetupMetadataQuery.Result"
}
}
}
}
}
}
},
"/Employees/{id}/candidacies": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Candidacy List",
"description": "Gets a list of candidacy records for the employee. The list is sorted by customer name by default.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdCandidaciesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "JobOrderCandidateStatusId",
"in": "query",
"description": "If provided, searches for candidacies with a CandidateStatusId that equals the provided value.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "OrderBy",
"in": "query",
"description": "Used to order the results by one of the returned columns. By default, the system sorts by CustomerName, then DepartmentName, then JobTitle.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "OrderByAscending",
"in": "query",
"description": "Used to specify the sort order. If left null, the system will order ascending automatically.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "Skip",
"in": "query",
"description": "The number of candidacies to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Take",
"in": "query",
"description": "The number of candidacies to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "RestrictToActiveCandidacies",
"in": "query",
"description": "If set to true only active candidates will be returned. If not set, both active and inactive candidates will be returned.",
"style": "form",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeCandidaciesQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeCandidaciesQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeCandidaciesQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeCandidaciesQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeCandidaciesQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeCandidaciesQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeCandidaciesQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Employees/{id}/candidacies/search": {
"post": {
"tags": [
"Employees"
],
"summary": "Search Employee Candidacies",
"description": "Returns a list of candidacy records for the employee. The list is sorted by customer name by default.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdCandidaciesSearchPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "A request with filter and sort parameters",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.SearchEmployeeCandidaciesRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.SearchEmployeeCandidaciesRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.SearchEmployeeCandidaciesRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.SearchEmployeeCandidaciesRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.SearchEmployeeCandidaciesRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.SearchEmployeeCandidaciesRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.SearchEmployeeCandidaciesRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.SearchEmployeeCandidaciesRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeCandidaciesQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeCandidaciesQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeCandidaciesQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeCandidaciesQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeCandidaciesQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeCandidaciesQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeCandidaciesQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Employees/{id}/candidacies/summary": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Employee Candidacy Summary",
"description": "Gets the number of candidacies in each status for the specified employee.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdCandidaciesSummaryGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of candidate statuses to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of candidate statuses to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeCandidacySummary.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeCandidacySummary.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeCandidacySummary.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeCandidacySummary.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeCandidacySummary.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeCandidacySummary.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeCandidacySummary.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Employees/{id}/contactmethods": {
"post": {
"tags": [
"Employees"
],
"summary": "Create Contact Method",
"description": "Creates a contact method for the specified employee.\n \n```` Allows roles: ServiceRep, Service, WebUserEmployee ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdContactmethodsPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The contact method to create",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMethods.CreateEntityContactMethodRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMethods.CreateEntityContactMethodRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMethods.CreateEntityContactMethodRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMethods.CreateEntityContactMethodRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMethods.CreateEntityContactMethodRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMethods.CreateEntityContactMethodRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMethods.CreateEntityContactMethodRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMethods.CreateEntityContactMethodRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.ContactMethods.CreateEntityContactMethodCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.ContactMethods.CreateEntityContactMethodCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.ContactMethods.CreateEntityContactMethodCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.ContactMethods.CreateEntityContactMethodCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.ContactMethods.CreateEntityContactMethodCommand.Result"
}
}
}
}
}
}
},
"/Employees/{id}/contactMethods": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Contact Method List",
"description": "Gets a list of contact methods for the specified employee. The contact methods are ordered alphabetically by their type.\n \n```` Allows roles: ServiceRep, Service, WebUserEmployee ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdContactMethodsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of contact methods to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of contact methods to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.ContactMethods.EntityContactMethod, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.ContactMethods.EntityContactMethod, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.ContactMethods.EntityContactMethod, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.ContactMethods.EntityContactMethod, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.ContactMethods.EntityContactMethod, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.ContactMethods.EntityContactMethod, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.ContactMethods.EntityContactMethod, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Employees/{id}/contactmethods/{contactMethodId}": {
"delete": {
"tags": [
"Employees"
],
"summary": "Delete Contact Method",
"description": "Deletes the specified contact method from the specified employee.\n \n```` Allows roles: ServiceRep, Service, WebUserEmployee ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdContactmethodsByContactMethodIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "contactMethodId",
"in": "path",
"description": "The Id of the contact method",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
},
"patch": {
"tags": [
"Employees"
],
"summary": "Patch Contact Method",
"description": "\r\n\r\n Performs the specified patching operations against the specified contact method for the specified employee.\r\n More information about PATCHING, see https://developer.ontempworks.com/docs/your-request\r\n \r\n\r\n\r\n Valid Patch paths: /ContactMethodTypeId(short), /ContactMethod(string), /IsActive(bool), /Notes(string), /WhenAvailable(string), /AreaCode(int), /ProviderId(int), /CountryCallingCode(int?), /IsPinned(bool)\r\n \n \n```` Allows roles: ServiceRep, WebUserEmployee, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdContactmethodsByContactMethodIdPatch",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "contactMethodId",
"in": "path",
"description": "The Id of the contact method",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The list of patch operations to perform on the contact method",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":"6514520366","path":"/ContactMethod","op":"replace"},{"value":1,"path":"/CountryCallingCode","op":"add"},{"path":"/CountryCallingCode","op":"remove"},{"path":"/Notes","op":"copy","from":"/CountryCallingCode"},{"path":"/Notes","op":"move","from":"/CountryCallingCode"},{"value":"6514520366","path":"/ContactMethod","op":"test"}]
},
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":"6514520366","path":"/ContactMethod","op":"replace"},{"value":1,"path":"/CountryCallingCode","op":"add"},{"path":"/CountryCallingCode","op":"remove"},{"path":"/Notes","op":"copy","from":"/CountryCallingCode"},{"path":"/Notes","op":"move","from":"/CountryCallingCode"},{"value":"6514520366","path":"/ContactMethod","op":"test"}]
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":"6514520366","path":"/ContactMethod","op":"replace"},{"value":1,"path":"/CountryCallingCode","op":"add"},{"path":"/CountryCallingCode","op":"remove"},{"path":"/Notes","op":"copy","from":"/CountryCallingCode"},{"path":"/Notes","op":"move","from":"/CountryCallingCode"},{"value":"6514520366","path":"/ContactMethod","op":"test"}]
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":"6514520366","path":"/ContactMethod","op":"replace"},{"value":1,"path":"/CountryCallingCode","op":"add"},{"path":"/CountryCallingCode","op":"remove"},{"path":"/Notes","op":"copy","from":"/CountryCallingCode"},{"path":"/Notes","op":"move","from":"/CountryCallingCode"},{"value":"6514520366","path":"/ContactMethod","op":"test"}]
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":"6514520366","path":"/ContactMethod","op":"replace"},{"value":1,"path":"/CountryCallingCode","op":"add"},{"path":"/CountryCallingCode","op":"remove"},{"path":"/Notes","op":"copy","from":"/CountryCallingCode"},{"path":"/Notes","op":"move","from":"/CountryCallingCode"},{"value":"6514520366","path":"/ContactMethod","op":"test"}]
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": "\r\n \r\n \r\n replace\r\n /ContactMethod\r\n 6514520366\r\n \r\n \r\n \r\n add\r\n /CountryCallingCode\r\n 1\r\n \r\n \r\n \r\n remove\r\n /CountryCallingCode\r\n \r\n \r\n \r\n /CountryCallingCode\r\n copy\r\n /Notes\r\n \r\n \r\n \r\n /CountryCallingCode\r\n move\r\n /Notes\r\n \r\n \r\n \r\n \r\n test\r\n /ContactMethod\r\n 6514520366\r\n \r\n"
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": "\r\n \r\n \r\n replace\r\n /ContactMethod\r\n 6514520366\r\n \r\n \r\n \r\n add\r\n /CountryCallingCode\r\n 1\r\n \r\n \r\n \r\n remove\r\n /CountryCallingCode\r\n \r\n \r\n \r\n /CountryCallingCode\r\n copy\r\n /Notes\r\n \r\n \r\n \r\n /CountryCallingCode\r\n move\r\n /Notes\r\n \r\n \r\n \r\n \r\n test\r\n /ContactMethod\r\n 6514520366\r\n \r\n"
},
"application/*+xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": "\r\n \r\n \r\n replace\r\n /ContactMethod\r\n 6514520366\r\n \r\n \r\n \r\n add\r\n /CountryCallingCode\r\n 1\r\n \r\n \r\n \r\n remove\r\n /CountryCallingCode\r\n \r\n \r\n \r\n /CountryCallingCode\r\n copy\r\n /Notes\r\n \r\n \r\n \r\n /CountryCallingCode\r\n move\r\n /Notes\r\n \r\n \r\n \r\n \r\n test\r\n /ContactMethod\r\n 6514520366\r\n \r\n"
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/contactMethods/{contactMethodId}": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Contact Method",
"description": "Gets the specified contact method for the specified employee.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdContactMethodsByContactMethodIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "contactMethodId",
"in": "path",
"description": "The Id of the contact method",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMethods.EntityContactMethod"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMethods.EntityContactMethod"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMethods.EntityContactMethod"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMethods.EntityContactMethod"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMethods.EntityContactMethod"
}
}
}
}
}
}
},
"/Employees/{id}/contactmethods/{contactMethodId}/text": {
"post": {
"tags": [
"Employees"
],
"summary": "Initiate a one to one text message conversation.",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): textmessage-read ````",
"operationId": "EmployeesByIdContactmethodsByContactMethodIdTextPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "contactMethodId",
"in": "path",
"description": "The Id of the contact method",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "A request containing the externalServiceId",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMethods.SendTextMessageToContactMethodRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMethods.SendTextMessageToContactMethodRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMethods.SendTextMessageToContactMethodRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMethods.SendTextMessageToContactMethodRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMethods.SendTextMessageToContactMethodRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMethods.SendTextMessageToContactMethodRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMethods.SendTextMessageToContactMethodRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMethods.SendTextMessageToContactMethodRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Texting.SendTextMessageToContactMethod.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Texting.SendTextMessageToContactMethod.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Texting.SendTextMessageToContactMethod.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Texting.SendTextMessageToContactMethod.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Texting.SendTextMessageToContactMethod.Result"
}
}
}
}
}
}
},
"/Employees/{id}/contactMethods/summary": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Contact Method Summary",
"description": "Gets the primary contact methods for the employee as well as all of the pinned contact methods and the total number of contact methods.\n \n```` Allows roles: ServiceRep, Service, WebUserEmployee ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdContactMethodsSummaryGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.ContactMethods.EntityContactMethod, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.ContactMethods.EntityContactMethod, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.ContactMethods.EntityContactMethod, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.ContactMethods.EntityContactMethod, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.ContactMethods.EntityContactMethod, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.ContactMethods.EntityContactMethod, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.ContactMethods.EntityContactMethod, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Employees/{id}/CustomData": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Custom Data",
"description": "Gets a list of Custom Data Properties for an Employee.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdCustomDataGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "includeInactiveProperties",
"in": "query",
"description": "When true, any properties that have been marked inactive will also be returned.",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.CustomData.EntityCustomDataQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.CustomData.EntityCustomDataQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.CustomData.EntityCustomDataQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.CustomData.EntityCustomDataQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.CustomData.EntityCustomDataQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.CustomData.EntityCustomDataQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.CustomData.EntityCustomDataQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"put": {
"tags": [
"Employees"
],
"summary": "Update Custom Data",
"description": "Updates the Custom Data Properties for an Employee.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdCustomDataPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The list of values to store.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.CustomData.UpdateEntityCustomDataRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.CustomData.UpdateEntityCustomDataRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.CustomData.UpdateEntityCustomDataRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.CustomData.UpdateEntityCustomDataRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.CustomData.UpdateEntityCustomDataRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.CustomData.UpdateEntityCustomDataRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.CustomData.UpdateEntityCustomDataRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.CustomData.UpdateEntityCustomDataRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/documents": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Employee Documents",
"description": "Get a list of documents linked to the specified employee.\n \n```` Allows roles: ServiceRep, WebUserEmployee, WebUserContact, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdDocumentsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of documents to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of documents to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "excludeIfLinkedToRequiredDocument",
"in": "query",
"description": "When true, the document will be excluded from the list if it is linked to a required document.",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "sortByAscending",
"in": "query",
"description": "true to sort by ASC, defaults to DESC",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "sortBy",
"in": "query",
"description": "Field to sort by, valid fields are \"DocumentType\" and \"DocumentDate\"",
"style": "form",
"schema": {
"type": "string",
"default": "DocumentDate"
}
},
{
"name": "filterByDocumentTypeId",
"in": "query",
"description": "DocumentTypeId to filter by",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Documents.GetEntityDocumentsQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Documents.GetEntityDocumentsQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Documents.GetEntityDocumentsQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Documents.GetEntityDocumentsQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Documents.GetEntityDocumentsQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Documents.GetEntityDocumentsQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Documents.GetEntityDocumentsQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Employees"
],
"summary": "Upload Document",
"description": "Uploads a document to the employee. This requires a multipart form-data POST request.\r\nOne part must contain the file to upload and subsequent parts will be used to provide\r\nother data such as documentTypeId.\r\n \r\nFor more information about using formdata, see: https://developer.mozilla.org/en-US/docs/Web/API/FormData/FormData\r\nFor more information about using multipart/form-data, see: http://stackoverflow.com/questions/4526273/what-does-enctype-multipart-form-data-mean\r\nBelow is an example multipart/form-data POST request body:\r\n \r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn\r\nContent-Disposition: form-data; name=\"file\"; filename=\"Test.txt\"\r\nContent-Type: text/plain\r\n \r\nThis is where the file content is placed!\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn\r\nContent-Disposition: form-data; name=\"fileName\"\r\n \r\nNewFileName.txt\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn\r\nContent-Disposition: form-data; name=\"expirationDate\"\r\n \r\n2012-12-21\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn\r\nContent-Disposition: form-data; name=\"documentTypeId\"\r\n \r\n1\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn\r\nContent-Disposition: form-data; name=\"version\"\r\n \r\n1\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn\r\nContent-Disposition: form-data; name=\"description\"\r\n \r\ntest\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn--\n \n```` Allows roles: Service, ServiceRep, WebUserEmployee, WebUserContact ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdDocumentsPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"201": {
"description": "Id of the new document",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
}
}
}
}
}
},
"/Employees/{id}/documents/{documentId}": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Document Details",
"description": "Get details for the specified document.\n \n```` Allows roles: ServiceRep, WebUserEmployee, WebUserContact, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdDocumentsByDocumentIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "documentId",
"in": "path",
"description": "The Id of the document.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.GetEntityDocumentQuery.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.GetEntityDocumentQuery.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.GetEntityDocumentQuery.Document"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.GetEntityDocumentQuery.Document"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.GetEntityDocumentQuery.Document"
}
}
}
}
}
},
"put": {
"tags": [
"Employees"
],
"summary": "Update Document Details",
"description": "Updates detail information about the specified document.\n \n```` Allows roles: ServiceRep, WebUserEmployee, WebUserContact, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdDocumentsByDocumentIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "documentId",
"in": "path",
"description": "The Id of the document.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The body of the request containing the updated details information.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Documents.UpdateEntityDocumentDetailsRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Documents.UpdateEntityDocumentDetailsRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Documents.UpdateEntityDocumentDetailsRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Documents.UpdateEntityDocumentDetailsRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Documents.UpdateEntityDocumentDetailsRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Documents.UpdateEntityDocumentDetailsRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Documents.UpdateEntityDocumentDetailsRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Documents.UpdateEntityDocumentDetailsRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
},
"delete": {
"tags": [
"Employees"
],
"summary": "Delete Document",
"description": "Deletes the specified document.\n \n```` Allows roles: ServiceRep, WebUserEmployee, WebUserContact, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdDocumentsByDocumentIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "documentId",
"in": "path",
"description": "The Id of the document.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/documents/{documentId}/bytes": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Document",
"description": "Gets the specified Document for the specified Employee.\n \n```` Allows roles: ServiceRep, WebUserEmployee, WebUserContact, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdDocumentsByDocumentIdBytesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "documentId",
"in": "path",
"description": "The Id of the document.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "returnPdf",
"in": "query",
"description": "Used to indicated whether or not a PDF should be returned if the file is convertible to PDF, if convert fails then nothing is returned",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "string",
"format": "byte"
}
},
"text/csv": {
"schema": {
"type": "string",
"format": "byte"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"type": "string",
"format": "byte"
}
},
"application/json": {
"schema": {
"type": "string",
"format": "byte"
}
},
"text/json": {
"schema": {
"type": "string",
"format": "byte"
}
},
"application/xml": {
"schema": {
"type": "string",
"format": "byte"
}
},
"text/xml": {
"schema": {
"type": "string",
"format": "byte"
}
}
}
}
}
}
},
"/Employees/{id}/documents/metadata": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Documents Metadata",
"description": "Returns information about document creation restrictions.\n \n```` Allows roles: ServiceRep, WebUserEmployee, WebUserContact, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdDocumentsMetadataGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.DocumentMetadataQuery.Query"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.DocumentMetadataQuery.Query"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.DocumentMetadataQuery.Query"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.DocumentMetadataQuery.Query"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.DocumentMetadataQuery.Query"
}
}
}
}
}
}
},
"/Employees/{id}/doNotAssigns": {
"get": {
"tags": [
"Employees"
],
"summary": "Get a paged list of employee-customer \"do not assign\" items.",
"description": "Returns all \"do not assign\" restrictions of an employee - both restricted by the employee and by customers.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdDoNotAssignsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The employee id.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "customerId",
"in": "query",
"description": "The customer id. If the customerId is provided the result will be filtered by the employee and the customer.",
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.AssignmentRestrictions.EmployeeCustomerDoNotAssign, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.AssignmentRestrictions.EmployeeCustomerDoNotAssign, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.AssignmentRestrictions.EmployeeCustomerDoNotAssign, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.AssignmentRestrictions.EmployeeCustomerDoNotAssign, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.AssignmentRestrictions.EmployeeCustomerDoNotAssign, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.AssignmentRestrictions.EmployeeCustomerDoNotAssign, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.AssignmentRestrictions.EmployeeCustomerDoNotAssign, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Employees"
],
"summary": "Creates a \"do not assign\" restriction between an employee and a customer.",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdDoNotAssignsPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The employee id. The initiator of the restriction.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The body of the request containing the information required to create a \"do not assign\" restriction.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeDoNotAssignRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeDoNotAssignRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeDoNotAssignRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeDoNotAssignRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeDoNotAssignRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeDoNotAssignRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeDoNotAssignRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeDoNotAssignRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.AssignmentRestrictions.CreateEmployeeCustomerDoNotAssign.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.AssignmentRestrictions.CreateEmployeeCustomerDoNotAssign.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.AssignmentRestrictions.CreateEmployeeCustomerDoNotAssign.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.AssignmentRestrictions.CreateEmployeeCustomerDoNotAssign.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.AssignmentRestrictions.CreateEmployeeCustomerDoNotAssign.Result"
}
}
}
}
}
}
},
"/Employees/{id}/doNotAssigns/{doNotAssignId}": {
"delete": {
"tags": [
"Employees"
],
"summary": "Delete a \"do not assign\" restriction between an employee and a customer.",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdDoNotAssignsByDoNotAssignIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The employee id.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "doNotAssignId",
"in": "path",
"description": "The id of the do not assign request.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/DriversLicense": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Employee Driver's License",
"description": "Gets the driver's license of the specified employee.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdDriversLicenseGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeDriversLicense.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeDriversLicense.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeDriversLicense.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeDriversLicense.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeDriversLicense.Result"
}
}
}
}
}
},
"put": {
"tags": [
"Employees"
],
"summary": "Update Employee Driver's License",
"description": "Updates the driver's license of the specified employee.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdDriversLicensePut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The request body containing the driver's license fields.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeDriversLicenseRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeDriversLicenseRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeDriversLicenseRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeDriversLicenseRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeDriversLicenseRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeDriversLicenseRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeDriversLicenseRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeDriversLicenseRequest"
}
}
}
},
"responses": {
"204": {
"description": ""
}
}
}
},
"/Employees/{id}/Education": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Education list",
"description": "Gets a list of education records for the specified employee. The education records are ordered from newest to the oldest.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdEducationGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "startDate",
"in": "query",
"description": "An optional parameter. Only records for which the employee was attending the institution during or after \r\nthe specified date will be returned.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "endDate",
"in": "query",
"description": "An optional parameter. Only records for which the employee was attending the institution during or before \r\nthe specified date will be returned.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Education.EmployeeEducationQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Education.EmployeeEducationQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Education.EmployeeEducationQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Education.EmployeeEducationQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Education.EmployeeEducationQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Education.EmployeeEducationQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Education.EmployeeEducationQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Employees"
],
"summary": "Create Education Record",
"description": "Creates a new education record for the employee.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdEducationPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The body of the request containing information about the new education record.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeEducationRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeEducationRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeEducationRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeEducationRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeEducationRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeEducationRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeEducationRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeEducationRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Education.CreateEmployeeEducationCommand.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Education.CreateEmployeeEducationCommand.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Education.CreateEmployeeEducationCommand.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Education.CreateEmployeeEducationCommand.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Education.CreateEmployeeEducationCommand.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Education.CreateEmployeeEducationCommand.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Education.CreateEmployeeEducationCommand.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Employees/{id}/Education/{educationId}": {
"put": {
"tags": [
"Employees"
],
"summary": "Update Education Record",
"description": "Updates an existing education record for the employee.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdEducationByEducationIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "educationId",
"in": "path",
"description": "The Id of the education record.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The body of the request containing updated information about the education record.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeEducationRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeEducationRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeEducationRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeEducationRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeEducationRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeEducationRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeEducationRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeEducationRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
},
"delete": {
"tags": [
"Employees"
],
"summary": "Delete Education Record",
"description": "Deletes an existing education record for the employee.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdEducationByEducationIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "educationId",
"in": "path",
"description": "The Id of the education record.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
},
"get": {
"tags": [
"Employees"
],
"summary": "Get Education Record Details",
"description": "Gets detailed information about an existing education record for the employee.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdEducationByEducationIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "educationId",
"in": "path",
"description": "The Id of the education record.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.Education.EmployeeEducationDetailsQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.Education.EmployeeEducationDetailsQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.Education.EmployeeEducationDetailsQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.Education.EmployeeEducationDetailsQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.Education.EmployeeEducationDetailsQuery.Result"
}
}
}
}
}
}
},
"/Employees/{id}/eeo": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Employee EEO",
"description": "Gets the employee's equal employment opportunity (EEO) information. If the EEO information has not been populated this will return no object.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdEeoGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeEEOQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeEEOQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeEEOQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeEEOQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeEEOQuery.Result"
}
}
}
}
}
},
"post": {
"tags": [
"Employees"
],
"summary": "Create Employee EEO",
"description": "Allows a user with the correct permission to create an EEO record for an employee. Use the Employee EEO Meta Data endpoint to determine whether the user can create an EEO record.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdEeoPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The request containing the EEO field values.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEeoRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEeoRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEeoRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEeoRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEeoRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEeoRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEeoRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEeoRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created"
}
}
},
"put": {
"tags": [
"Employees"
],
"summary": "Update Employee EEO",
"description": "Allows a user with the correct permission to update an EEO record for an employee. Use the Employee EEO Meta Data endpoint to determine whether the user can update an EEO record.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdEeoPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The request containing the updated EEO field values.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEeoRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEeoRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEeoRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEeoRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEeoRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEeoRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEeoRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEeoRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/eeo/metadata": {
"get": {
"tags": [
"Employees"
],
"summary": "Employee EEO Meta data",
"description": "Returns information about the current state of the employee's eeo information and what actions the user can take with it.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdEeoMetadataGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeEEOMetaQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeEEOMetaQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeEEOMetaQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeEEOMetaQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeEEOMetaQuery.Result"
}
}
}
}
}
}
},
"/Employees/{id}/electronicPay": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Employee Electronic Pay",
"description": "Returns the electronic pay settings for an employee. The employee can only have one ACH or one paycard setup in this area. Additional electronic pays must be setup on the adjustments.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdElectronicPayGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeElectronicPayQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeElectronicPayQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeElectronicPayQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeElectronicPayQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeElectronicPayQuery.Result"
}
}
}
}
}
},
"put": {
"tags": [
"Employees"
],
"summary": "Update Employee Electronic Pay Settings",
"description": "This will update the electronic bank type and active status on the employee electronic pay.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdElectronicPayPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The settings for the employee electronic pay",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateElectronicPayRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateElectronicPayRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateElectronicPayRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateElectronicPayRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateElectronicPayRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateElectronicPayRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateElectronicPayRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateElectronicPayRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/electronicPay/bankaccount": {
"put": {
"tags": [
"Employees"
],
"summary": "Update Electronic Pay Bank Account",
"description": "Updates and activates the bank account (ACH/BACS) as the primary employee electronic pay option.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdElectronicPayBankaccountPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The identifier for the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The bank account information to update the employee file with.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateElectronicPayBankAccountRequestModel"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateElectronicPayBankAccountRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateElectronicPayBankAccountRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateElectronicPayBankAccountRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateElectronicPayBankAccountRequestModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateElectronicPayBankAccountRequestModel"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateElectronicPayBankAccountRequestModel"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateElectronicPayBankAccountRequestModel"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/electronicPay/metadata": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Electronic Pay Metadata",
"description": "Returns information regarding the current state and restrictions on an employee's electronic pay setup\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdElectronicPayMetadataGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeElectronicPayMetaDataQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeElectronicPayMetaDataQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeElectronicPayMetaDataQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeElectronicPayMetaDataQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeElectronicPayMetaDataQuery.Result"
}
}
}
}
}
}
},
"/Employees/{id}/electronicPay/paycardAccount": {
"put": {
"tags": [
"Employees"
],
"summary": "Update Electronic Pay Paycard Account",
"description": "Updates and activates the paycard account as the primary employee electronic pay option.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdElectronicPayPaycardAccountPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The identifier for the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The paycard account information to update the employee file with.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateElectronicPayPaycardAccountRequestModel"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateElectronicPayPaycardAccountRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateElectronicPayPaycardAccountRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateElectronicPayPaycardAccountRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateElectronicPayPaycardAccountRequestModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateElectronicPayPaycardAccountRequestModel"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateElectronicPayPaycardAccountRequestModel"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateElectronicPayPaycardAccountRequestModel"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
},
"delete": {
"tags": [
"Employees"
],
"summary": "Delete Electronic Pay Paycard Account",
"description": "Deletes the paycard account information from the employee electronic pay. This should be called prior to setting up a new paycard on the employee record. \r\nThis may only be called if the employee is not currently in a payroll run or has a bank account setup that has a pending ACH Run to be submitted.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdElectronicPayPaycardAccountDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The identifier for the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/electronicPay/paycardAccount/enrollmentvalidationerrors": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Paycard Enrollment Validation Errors",
"description": "This endpoint will return all errors caused by the employee record not meeting any of the enrollment cretiria required by the paycard vendor\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdElectronicPayPaycardAccountEnrollmentvalidationerrorsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The identifier for the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "paycardVendorId",
"in": "query",
"description": "The Id of the paycard vendor the employee will be enrolled on.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Models.EmployeeEnrollmentValidationError"
}
}
},
"text/csv": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Models.EmployeeEnrollmentValidationError"
}
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Models.EmployeeEnrollmentValidationError"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Models.EmployeeEnrollmentValidationError"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Models.EmployeeEnrollmentValidationError"
}
}
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Models.EmployeeEnrollmentValidationError"
}
}
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Models.EmployeeEnrollmentValidationError"
}
}
}
}
}
}
}
},
"/Employees/{id}/electronicPay/updatePaycardStatus": {
"put": {
"tags": [
"Employees"
],
"summary": "Update Paycard Status",
"description": "Will attempt to update the paycard status for an employees electronic pay and then return the new result.\r\n This endpoint will check the enrollment status and validate the paycard with VISA when the card is an ADP ALINE Card.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdElectronicPayUpdatePaycardStatusPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Paycards.UpdatePaycardStatusCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Paycards.UpdatePaycardStatusCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Paycards.UpdatePaycardStatusCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Paycards.UpdatePaycardStatusCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Paycards.UpdatePaycardStatusCommand.Result"
}
}
}
}
}
}
},
"/Employees/{id}/Everify/Cases/AllCases": {
"get": {
"tags": [
"Employees"
],
"summary": "Get all cases.",
"description": "V30 Only.\r\nReturns a List of E-Verify cases for a specified employee.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): everify-read or everify-write ````",
"operationId": "EmployeesByIdEverifyCasesAllCasesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Employees/{id}/Everify/Cases/CaseDetails": {
"get": {
"tags": [
"Employees"
],
"summary": "Get E-Verify case details",
"description": "Returns a specific E-Verify cases details.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): everify-write ````",
"operationId": "EmployeesByIdEverifyCasesCaseDetailsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "caseNumber",
"in": "query",
"description": "RetrieveCaseRequest",
"style": "form",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.I9CaseFlatItem"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.I9CaseFlatItem"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.I9CaseFlatItem"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.I9CaseFlatItem"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.I9CaseFlatItem"
}
}
}
}
}
}
},
"/Employees/{id}/Everify/Cases/Close": {
"post": {
"tags": [
"Employees"
],
"summary": "Close an E-Verify Case",
"description": "V30 only.\r\nA call to this operation allows an E-Verify user to close a case when appropriate.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): everify-write ````",
"operationId": "EmployeesByIdEverifyCasesClosePost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CloseRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CloseRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CloseRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CloseRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CloseRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CloseRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CloseRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CloseRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListResponse"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListResponse"
}
}
}
}
}
}
},
"/Employees/{id}/Everify/Cases/Close/Validate": {
"post": {
"tags": [
"Employees"
],
"summary": "V30 only.\r\nValidate Close request for an E-Verify Case",
"description": "Validate a Close Case request.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): everify-write ````",
"operationId": "EmployeesByIdEverifyCasesCloseValidatePost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CloseRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CloseRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CloseRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CloseRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CloseRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CloseRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CloseRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CloseRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/Everify/Cases/CloseCase": {
"post": {
"tags": [
"Employees"
],
"summary": "Close the Case.",
"description": "V30 only.\r\nThis is a pseudo step.\r\nMust select a reason for closing the case.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): everify-write ````",
"operationId": "EmployeesByIdEverifyCasesCloseCasePost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "CaseNumberRequest",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CaseNumberRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CaseNumberRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CaseNumberRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CaseNumberRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CaseNumberRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CaseNumberRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CaseNumberRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CaseNumberRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
}
}
}
}
}
},
"/Employees/{id}/Everify/Cases/ClosureReasons": {
"post": {
"tags": [
"Employees"
],
"summary": "Get closure reasons for an E-Verify Case",
"description": "V30 only.\r\nA call to this operation allows an E-Verify user to retrieve the currently valid closure reasons for a case based on its current status.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): everify-write ````",
"operationId": "EmployeesByIdEverifyCasesClosureReasonsPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CaseNumberRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CaseNumberRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CaseNumberRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CaseNumberRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CaseNumberRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CaseNumberRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CaseNumberRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CaseNumberRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Employees/{id}/Everify/Cases/ConfirmDetails": {
"post": {
"tags": [
"Employees"
],
"summary": "Confirm E-Verify Details",
"description": "V30 only.\r\nConfirms the field values requested from the ConfirmDetailsFields request with E-Verify.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): everify-write ````",
"operationId": "EmployeesByIdEverifyCasesConfirmDetailsPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "ConfirmDetailsRequest",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.ConfirmDetailsRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.ConfirmDetailsRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.ConfirmDetailsRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.ConfirmDetailsRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.ConfirmDetailsRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.ConfirmDetailsRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.ConfirmDetailsRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.ConfirmDetailsRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
}
}
}
}
}
},
"/Employees/{id}/Everify/Cases/ConfirmDetails/Validate": {
"post": {
"tags": [
"Employees"
],
"summary": "Validate Confirm E-Verify Details",
"description": "V30 only.\r\nValidates the field values requested from the ConfirmDetailsFields request with E-Verify.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): everify-write ````",
"operationId": "EmployeesByIdEverifyCasesConfirmDetailsValidatePost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "ConfirmDetailsRequest",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.ConfirmDetailsRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.ConfirmDetailsRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.ConfirmDetailsRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.ConfirmDetailsRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.ConfirmDetailsRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.ConfirmDetailsRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.ConfirmDetailsRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.ConfirmDetailsRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
}
}
}
}
}
},
"/Employees/{id}/Everify/Cases/ContinueCase": {
"post": {
"tags": [
"Employees"
],
"summary": "Get a case to continue.",
"description": "V30 Only.\r\nReturns an existing open case workflow.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): everify-read or everify-write ````",
"operationId": "EmployeesByIdEverifyCasesContinueCasePost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "CaseNumberRequest",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CaseNumberRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CaseNumberRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CaseNumberRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CaseNumberRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CaseNumberRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CaseNumberRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CaseNumberRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CaseNumberRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
}
}
}
}
}
},
"/Employees/{id}/Everify/Cases/CreateAndSubmitCase": {
"post": {
"tags": [
"Employees"
],
"summary": "Create and Submit a Case.",
"description": "V30 only.\r\nCreate a new case in the E-Verify system and Submit the case for processing.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): everify-write ````",
"operationId": "EmployeesByIdEverifyCasesCreateAndSubmitCasePost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The E-Verify verification request details.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CreateCaseRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CreateCaseRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CreateCaseRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CreateCaseRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CreateCaseRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CreateCaseRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CreateCaseRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CreateCaseRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
}
}
}
}
}
},
"/Employees/{id}/Everify/Cases/CreateAndSubmitCase/Validate": {
"post": {
"tags": [
"Employees"
],
"summary": "Validate a Case to be created with E-Verify.",
"description": "V30 only.\r\nValidate a new case to be created with E-Verify system.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): everify-write ````",
"operationId": "EmployeesByIdEverifyCasesCreateAndSubmitCaseValidatePost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The E-Verify verification request details.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CreateCaseRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CreateCaseRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CreateCaseRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CreateCaseRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CreateCaseRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CreateCaseRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CreateCaseRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CreateCaseRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/Everify/Cases/CreateCase": {
"post": {
"tags": [
"Employees"
],
"summary": "Create an E-Verify Case.",
"description": "V30 only.\r\nCreate a new case in the E-Verify system. The result should be a draft case with a case number.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): everify-write ````",
"operationId": "EmployeesByIdEverifyCasesCreateCasePost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "CreateCaseRequest",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CreateCaseRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CreateCaseRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CreateCaseRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CreateCaseRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CreateCaseRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CreateCaseRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CreateCaseRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CreateCaseRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
}
}
}
}
}
},
"/Employees/{id}/Everify/Cases/DuplicateCheck": {
"post": {
"tags": [
"Employees"
],
"summary": "Check for duplicate E-Verify Case",
"description": "V30 only.\r\nChecks for duplicate cases based on the client company id and social security number. The client company id is optional.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): everify-write ````",
"operationId": "EmployeesByIdEverifyCasesDuplicateCheckPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "DuplicateCheckRequest",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.DuplicateCheckRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.DuplicateCheckRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.DuplicateCheckRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.DuplicateCheckRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.DuplicateCheckRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.DuplicateCheckRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.DuplicateCheckRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.DuplicateCheckRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.DuplicateCheckResponseItem"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.DuplicateCheckResponseItem"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.DuplicateCheckResponseItem"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.DuplicateCheckResponseItem"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.DuplicateCheckResponseItem"
}
}
}
}
}
}
},
"/Employees/{id}/Everify/Cases/EditAndSubmitCase": {
"post": {
"tags": [
"Employees"
],
"summary": "Edit and Submit a Case.",
"description": "V30 only.\r\nEdit a case in the E-Verify system and Submit the case for processing.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): everify-write ````",
"operationId": "EmployeesByIdEverifyCasesEditAndSubmitCasePost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The E-Verify verification request details.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.EditCaseRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.EditCaseRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.EditCaseRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.EditCaseRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.EditCaseRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.EditCaseRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.EditCaseRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.EditCaseRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
}
}
}
}
}
},
"/Employees/{id}/Everify/Cases/FurtherActionNotice": {
"post": {
"tags": [
"Employees"
],
"summary": "Get Further Action Notice for an E-Verify Case",
"description": "V30 only.\r\nRetrieve a further action notice to give to the employee in the specified language.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): everify-write ````",
"operationId": "EmployeesByIdEverifyCasesFurtherActionNoticePost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "NoticeRequest",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.NoticeRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.NoticeRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.NoticeRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.NoticeRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.NoticeRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.NoticeRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.NoticeRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.NoticeRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "string",
"format": "byte"
}
},
"text/csv": {
"schema": {
"type": "string",
"format": "byte"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"type": "string",
"format": "byte"
}
},
"application/json": {
"schema": {
"type": "string",
"format": "byte"
}
},
"text/json": {
"schema": {
"type": "string",
"format": "byte"
}
},
"application/xml": {
"schema": {
"type": "string",
"format": "byte"
}
},
"text/xml": {
"schema": {
"type": "string",
"format": "byte"
}
}
}
}
}
}
},
"/Employees/{id}/Everify/Cases/FurtherActionNotice/Validate": {
"post": {
"tags": [
"Employees"
],
"summary": "Validate Further Action Notice Request",
"description": "V30 only.\r\nValidate a further action notice request to give to the employee in a specific language.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): everify-write ````",
"operationId": "EmployeesByIdEverifyCasesFurtherActionNoticeValidatePost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "NoticeRequest",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.NoticeRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.NoticeRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.NoticeRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.NoticeRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.NoticeRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.NoticeRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.NoticeRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.NoticeRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/Everify/Cases/NewCase": {
"get": {
"tags": [
"Employees"
],
"summary": "Get a New Case prefilled with the specific employees information.",
"description": "V30 only.\r\nGet a New Case prefilled with the specific employees information.\r\nAlso returns duplicate cases.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): everify-write ````",
"operationId": "EmployeesByIdEverifyCasesNewCaseGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
}
}
}
}
}
},
"/Employees/{id}/Everify/Cases/NoAction": {
"post": {
"tags": [
"Employees"
],
"summary": "No Action Taken",
"description": "V30 only.\r\nNotify E-Verify that the employee wishes not to contest after receiving a TNC and downloading the further action notice.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): everify-write ````",
"operationId": "EmployeesByIdEverifyCasesNoActionPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.NotifiedRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.NotifiedRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.NotifiedRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.NotifiedRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.NotifiedRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.NotifiedRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.NotifiedRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.NotifiedRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
}
}
}
}
}
},
"/Employees/{id}/Everify/Cases/OpenCases": {
"get": {
"tags": [
"Employees"
],
"summary": "Get open cases.",
"description": "V30 Only.\r\nReturns all open cases for the specified employee..\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): everify-read or everify-write ````",
"operationId": "EmployeesByIdEverifyCasesOpenCasesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Employees/{id}/Everify/Cases/PhotoMatch": {
"post": {
"tags": [
"Employees"
],
"summary": "Photo Match with E-Verify.",
"description": "V30 only.\r\nConfirm whether a photo matches the employees document.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): everify-write ````",
"operationId": "EmployeesByIdEverifyCasesPhotoMatchPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "PhotoMatchRequest",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.PhotoMatchRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.PhotoMatchRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.PhotoMatchRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.PhotoMatchRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.PhotoMatchRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.PhotoMatchRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.PhotoMatchRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.PhotoMatchRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
}
}
}
}
}
},
"/Employees/{id}/Everify/Cases/PhotoMatch/Validate": {
"post": {
"tags": [
"Employees"
],
"summary": "V30 only.\r\nValidate a photo match request for an E-Verify Case",
"description": "Validate a photo match request for photo matching with an employees documents.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): everify-write ````",
"operationId": "EmployeesByIdEverifyCasesPhotoMatchValidatePost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.PhotoMatchRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.PhotoMatchRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.PhotoMatchRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.PhotoMatchRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.PhotoMatchRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.PhotoMatchRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.PhotoMatchRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.PhotoMatchRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/Everify/Cases/Refer": {
"post": {
"tags": [
"Employees"
],
"summary": "Refer Employee to E-Verify.",
"description": "V30 only.\r\nNotify E-Verify that the employee wishes to contest after receiving a TNC and downloading the further action notice.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): everify-write ````",
"operationId": "EmployeesByIdEverifyCasesReferPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "NotifiedRequest",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.NotifiedRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.NotifiedRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.NotifiedRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.NotifiedRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.NotifiedRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.NotifiedRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.NotifiedRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.NotifiedRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
}
}
}
}
}
},
"/Employees/{id}/Everify/Cases/ReferCase": {
"post": {
"tags": [
"Employees"
],
"summary": "Notify Employee.",
"description": "V30 only.\r\nThis is a pseudo step.\r\nNotify the employee that they must contact SSA or DHS.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): everify-write ````",
"operationId": "EmployeesByIdEverifyCasesReferCasePost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "CaseNumberRequest",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CaseNumberRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CaseNumberRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CaseNumberRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CaseNumberRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CaseNumberRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CaseNumberRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CaseNumberRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CaseNumberRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
}
}
}
}
}
},
"/Employees/{id}/Everify/Cases/ReferralDateConfirmation": {
"post": {
"tags": [
"Employees"
],
"summary": "Get Referral Date Confimation Notice.",
"description": "V30 only.\r\nRetrieve a referral date confimation notice to give to the employee in a specific language.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): everify-write ````",
"operationId": "EmployeesByIdEverifyCasesReferralDateConfirmationPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "NoticeRequest",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.NoticeRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.NoticeRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.NoticeRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.NoticeRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.NoticeRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.NoticeRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.NoticeRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.NoticeRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "string",
"format": "byte"
}
},
"text/csv": {
"schema": {
"type": "string",
"format": "byte"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"type": "string",
"format": "byte"
}
},
"application/json": {
"schema": {
"type": "string",
"format": "byte"
}
},
"text/json": {
"schema": {
"type": "string",
"format": "byte"
}
},
"application/xml": {
"schema": {
"type": "string",
"format": "byte"
}
},
"text/xml": {
"schema": {
"type": "string",
"format": "byte"
}
}
}
}
}
}
},
"/Employees/{id}/Everify/Cases/ReferralDateConfirmation/Validate": {
"post": {
"tags": [
"Employees"
],
"summary": "Validate the Referral Date Confimation Notice Request",
"description": "V30 only.\r\nValidate a referral date confimation notice request to give to the employee in a specific language.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): everify-write ````",
"operationId": "EmployeesByIdEverifyCasesReferralDateConfirmationValidatePost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.NoticeRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.NoticeRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.NoticeRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.NoticeRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.NoticeRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.NoticeRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.NoticeRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.NoticeRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/Everify/Cases/RetrieveCase": {
"post": {
"tags": [
"Employees"
],
"summary": "Get E-Verify case",
"description": "Returns an specific E-Verify cases details.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): everify-write ````",
"operationId": "EmployeesByIdEverifyCasesRetrieveCasePost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "RetrieveCaseRequest",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.RetrieveCaseRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.RetrieveCaseRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.RetrieveCaseRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.RetrieveCaseRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.RetrieveCaseRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.RetrieveCaseRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.RetrieveCaseRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.RetrieveCaseRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
}
}
}
}
}
},
"/Employees/{id}/Everify/Cases/ScanAndUpload": {
"post": {
"tags": [
"Employees"
],
"summary": "Scan and Upload Documents to E-Verify.",
"description": "V30 only.\r\nScan and Upload documents (Front and Back) using Multi-Part form-data\r\nFor more information about using formdata, see: https://developer.mozilla.org/en-US/docs/Web/API/FormData/FormData\r\nFor more information about using multimart/form-data, see: http://stackoverflow.com/questions/4526273/what-does-enctype-multipart-form-data-mean\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): everify-write ````",
"operationId": "EmployeesByIdEverifyCasesScanAndUploadPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
}
}
}
}
}
},
"/Employees/{id}/Everify/Cases/SubmitCase": {
"post": {
"tags": [
"Employees"
],
"summary": "Submit an E-Verify Case",
"description": "V30 Only.\r\nSubmits a draft case to E-Verify for processing.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): everify-write ````",
"operationId": "EmployeesByIdEverifyCasesSubmitCasePost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "CaseNumberRequest",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CaseNumberRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CaseNumberRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CaseNumberRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CaseNumberRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CaseNumberRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CaseNumberRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CaseNumberRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CaseNumberRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
}
}
}
}
}
},
"/Employees/{id}/Everify/Cases/TakeNoAction": {
"post": {
"tags": [
"Employees"
],
"summary": "Notify Employee.",
"description": "V30 only.\r\nThis is a pseudo step.\r\nNotify the employee that they may be terminated as a result of the final non-confirmation.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): everify-write ````",
"operationId": "EmployeesByIdEverifyCasesTakeNoActionPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "CaseNumberRequest",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CaseNumberRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CaseNumberRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CaseNumberRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CaseNumberRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CaseNumberRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CaseNumberRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CaseNumberRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.CaseNumberRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
}
}
}
}
}
}
},
"/Employees/{id}/Everify/Metadata": {
"get": {
"tags": [
"Employees"
],
"summary": "Get E-Verify Metadata",
"description": "Returns E-Verify Metadata Information for the Employee.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): everify-read or everify-write ````",
"operationId": "EmployeesByIdEverifyMetadataGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow.CaseMetaData"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow.CaseMetaData"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow.CaseMetaData"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow.CaseMetaData"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow.CaseMetaData"
}
}
}
}
}
}
},
"/Employees/{id}/governmentPersonalIdentifier": {
"put": {
"tags": [
"Employees"
],
"summary": "Update Employee Government Personal Identifier",
"description": "Updates the government personal identifier of the specified employee.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdGovernmentPersonalIdentifierPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The request body containing the country code and government personal identifier",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeGovernmentPersonalIdentifierRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeGovernmentPersonalIdentifierRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeGovernmentPersonalIdentifierRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeGovernmentPersonalIdentifierRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeGovernmentPersonalIdentifierRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeGovernmentPersonalIdentifierRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeGovernmentPersonalIdentifierRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeGovernmentPersonalIdentifierRequest"
}
}
}
},
"responses": {
"204": {
"description": ""
}
}
}
},
"/Employees/{id}/governmentPersonalIdentifier/validate": {
"put": {
"tags": [
"Employees"
],
"summary": "Validate Employee Government Personal Identifier",
"description": "Validates a government personal identifier for the specified employee. Returns 200 if the identifier is formatted properly and is not currently in use by another employee.\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdGovernmentPersonalIdentifierValidatePut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The request body containing the country code and government personal identifier",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeGovernmentPersonalIdentifierRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeGovernmentPersonalIdentifierRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeGovernmentPersonalIdentifierRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeGovernmentPersonalIdentifierRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeGovernmentPersonalIdentifierRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeGovernmentPersonalIdentifierRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeGovernmentPersonalIdentifierRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeGovernmentPersonalIdentifierRequest"
}
}
}
},
"responses": {
"200": {
"description": ""
}
}
}
},
"/Employees/{id}/interestCodes": {
"put": {
"tags": [
"Employees"
],
"summary": "Update Employee Interest Codes",
"description": "Updates an employee's interest codes.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdInterestCodesPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The request body containing an updated list of the employee's interest codes.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeInterestCodesRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeInterestCodesRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeInterestCodesRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeInterestCodesRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeInterestCodesRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeInterestCodesRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeInterestCodesRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeInterestCodesRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/InterestCodes": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Interest Code List",
"description": "Gets a list of interest codes for the specified employee. Interest codes are used to track employee skills, preferences, or other attributes. The interest codes are ordered by sub category and then code.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdInterestCodesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of interest codes to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of interest codes to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeInterestCodeListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeInterestCodeListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeInterestCodeListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeInterestCodeListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeInterestCodeListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeInterestCodeListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeInterestCodeListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Employees"
],
"summary": "Create Employee Interest Code",
"description": "Creates an interest code for the specified employee.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdInterestCodesPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "Request object used to create the interest code",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeInterestCodeRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeInterestCodeRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeInterestCodeRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeInterestCodeRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeInterestCodeRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeInterestCodeRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeInterestCodeRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeInterestCodeRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.CreateEmployeeInterestCodeCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.CreateEmployeeInterestCodeCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.CreateEmployeeInterestCodeCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.CreateEmployeeInterestCodeCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.CreateEmployeeInterestCodeCommand.Result"
}
}
}
}
}
}
},
"/Employees/{id}/interestCodes/{employeeInterestCodeId}": {
"put": {
"tags": [
"Employees"
],
"summary": "Update Employee Interest Code",
"description": "Updates an employee interest code. Note that updates on the InterestCodeId will set the date created to today.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdInterestCodesByEmployeeInterestCodeIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "employeeInterestCodeId",
"in": "path",
"description": "The Id of the employee interest code.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The request body containing the employee interest code to update.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeInterestCodeRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeInterestCodeRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeInterestCodeRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeInterestCodeRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeInterestCodeRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeInterestCodeRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeInterestCodeRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeInterestCodeRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/InterestCodes/{employeeInterestCodeId}": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Employee Interest Code",
"description": "Gets an interest code for the specified employee.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdInterestCodesByEmployeeInterestCodeIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "employeeInterestCodeId",
"in": "path",
"description": "The Id of the employee interest code",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeInterestCodeQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeInterestCodeQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeInterestCodeQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeInterestCodeQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeInterestCodeQuery.Result"
}
}
}
}
}
},
"delete": {
"tags": [
"Employees"
],
"summary": "Delete Employee Interest Code",
"description": "Deletes an interest code from the specified employee.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdInterestCodesByEmployeeInterestCodeIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "employeeInterestCodeId",
"in": "path",
"description": "The Id of the employee interest code",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/Interviews": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Employee Interviews with Questions and Answers",
"description": "Gets a list of interviews along with their questions and answers assigned to the employee.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdInterviewsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.AssignedEmployeeInterviewWithDetails.DatabaseResult, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.AssignedEmployeeInterviewWithDetails.DatabaseResult, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.AssignedEmployeeInterviewWithDetails.DatabaseResult, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.AssignedEmployeeInterviewWithDetails.DatabaseResult, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.AssignedEmployeeInterviewWithDetails.DatabaseResult, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.AssignedEmployeeInterviewWithDetails.DatabaseResult, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.AssignedEmployeeInterviewWithDetails.DatabaseResult, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Employees"
],
"summary": "Create Employee Interview.",
"description": "Assigns an interview and a list of category ids to an employee.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdInterviewsPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "A model containing a list of categories ids and the interview's name.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeInterviewRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeInterviewRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeInterviewRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeInterviewRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeInterviewRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeInterviewRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeInterviewRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeInterviewRequest"
}
}
}
},
"responses": {
"201": {
"description": ""
}
}
}
},
"/Employees/{id}/Interviews/{interviewId}": {
"get": {
"tags": [
"Employees"
],
"summary": "Get a specific Assigned Interview",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdInterviewsByInterviewIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "interviewId",
"in": "path",
"description": "The Id of the interview.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeInterviewDetails.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeInterviewDetails.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeInterviewDetails.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeInterviewDetails.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeInterviewDetails.Result"
}
}
}
}
}
},
"delete": {
"tags": [
"Employees"
],
"summary": "Delete Assigned Interview, its Categories and Questions",
"description": "Delete an employee's assigned interview all its categories and the employee's answers to questions in these categories.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdInterviewsByInterviewIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "interviewId",
"in": "path",
"description": "The Id of the assigned interview.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
},
"put": {
"tags": [
"Employees"
],
"summary": "Update Employee Interview",
"description": "Updates Employee Interview.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdInterviewsByInterviewIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "interviewId",
"in": "path",
"description": "The Id of the interview.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "A model containing the information to be used to update the interview.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateInterviewRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateInterviewRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateInterviewRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateInterviewRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateInterviewRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateInterviewRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateInterviewRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateInterviewRequest"
}
}
}
},
"responses": {
"204": {
"description": ""
}
}
}
},
"/Employees/{id}/Interviews/{interviewId}/Categories/{assignedCategoryId}": {
"delete": {
"tags": [
"Employees"
],
"summary": "Delete Assigned Interview Category and its Questions",
"description": "Delete the assigned interview category for the employee, and all the employee's answers to questions in the category.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdInterviewsByInterviewIdCategoriesByAssignedCategoryIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "interviewId",
"in": "path",
"description": "The Id of the interview.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "assignedCategoryId",
"in": "path",
"description": "The Id of the assigned interview category.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/Interviews/{interviewId}/Categories/{assignedCategoryId}/Questions/{assignedQuestionId}": {
"delete": {
"tags": [
"Employees"
],
"summary": "Delete Interview Answer",
"description": "Deletes the employee's answer to an interview question.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdInterviewsByInterviewIdCategoriesByAssignedCategoryIdQuestionsByAssignedQuestionIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "interviewId",
"in": "path",
"description": "The Id of the assigned interview.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "assignedCategoryId",
"in": "path",
"description": "The Id of the assigned interview category.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "assignedQuestionId",
"in": "path",
"description": "The Id of the assigned interview question.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/Interviews/{interviewId}/Categories/{assignedCategoryId}/Questions/{questionId}": {
"put": {
"tags": [
"Employees"
],
"summary": "Upsert Interview Answer",
"description": "Adds or updates an employee interview answer.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdInterviewsByInterviewIdCategoriesByAssignedCategoryIdQuestionsByQuestionIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "interviewId",
"in": "path",
"description": "The Id of the assigned interview.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "assignedCategoryId",
"in": "path",
"description": "The Id of the assigned category.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "questionId",
"in": "path",
"description": "The Id of the assigned category question.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The body of the request containing the key \"Answer\". The answer is deleted if this is blank.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeInterviewAnswerRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeInterviewAnswerRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeInterviewAnswerRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeInterviewAnswerRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeInterviewAnswerRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeInterviewAnswerRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeInterviewAnswerRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeInterviewAnswerRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/Interviews/{interviewId}/complete": {
"put": {
"tags": [
"Employees"
],
"summary": "Completes an Interview.",
"description": "Marks an employee interview as completed. Completing is allowed only\r\nif an interview has not already been completed.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdInterviewsByInterviewIdCompletePut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "interviewId",
"in": "path",
"description": "The Id of the interview.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"204": {
"description": ""
}
}
}
},
"/Employees/{id}/Interviews/Categories": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Assigned Interview Categories",
"description": "Gets a list of interview categories assigned to the employee.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdInterviewsCategoriesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.AssignedEmployeeInterviewCategories.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.AssignedEmployeeInterviewCategories.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.AssignedEmployeeInterviewCategories.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.AssignedEmployeeInterviewCategories.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.AssignedEmployeeInterviewCategories.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.AssignedEmployeeInterviewCategories.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.AssignedEmployeeInterviewCategories.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
},
"deprecated": true
},
"post": {
"tags": [
"Employees"
],
"summary": "Assign Employee Interview Categories",
"description": "Assigns a list of category ids to an employee.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdInterviewsCategoriesPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "A model containing a list of categories ids.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.AssignEmployeeInterviewCategoriesRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.AssignEmployeeInterviewCategoriesRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.AssignEmployeeInterviewCategoriesRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.AssignEmployeeInterviewCategoriesRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.AssignEmployeeInterviewCategoriesRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.AssignEmployeeInterviewCategoriesRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.AssignEmployeeInterviewCategoriesRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.AssignEmployeeInterviewCategoriesRequest"
}
}
}
},
"responses": {
"201": {
"description": ""
}
},
"deprecated": true
}
},
"/Employees/{id}/Interviews/Categories/{categoryId}": {
"delete": {
"tags": [
"Employees"
],
"summary": "Delete Assigned Interview Category and Questions",
"description": "Delete the assigned interview category for the employee, and all the employee's answers to questions in the category.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdInterviewsCategoriesByCategoryIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "categoryId",
"in": "path",
"description": "The Id of the interview category.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
},
"deprecated": true
},
"put": {
"tags": [
"Employees"
],
"summary": "Update Assigned Interview Questions",
"description": "Saves Interview answers and interview category.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdInterviewsCategoriesByCategoryIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "categoryId",
"in": "path",
"description": "The Id of the interview category",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "A model containing a list of categories ids.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateInterviewQuestionsRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateInterviewQuestionsRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateInterviewQuestionsRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateInterviewQuestionsRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateInterviewQuestionsRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateInterviewQuestionsRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateInterviewQuestionsRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateInterviewQuestionsRequest"
}
}
}
},
"responses": {
"204": {
"description": ""
}
},
"deprecated": true
}
},
"/Employees/{id}/Interviews/Categories/{categoryId}/Questions": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Assigned Interview Category Questions",
"description": "Gets a list of questions for the specified interview category assigned to the employee. Each question includes the employee's answer if available.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdInterviewsCategoriesByCategoryIdQuestionsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "categoryId",
"in": "path",
"description": "The Id of the interview category.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "includeInactive",
"in": "query",
"description": "Boolean to determine whether to include inactive questions. Inactive questions are omitted from results unless this is set to true.",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.AssignedEmployeeInterviewQuestions.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.AssignedEmployeeInterviewQuestions.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.AssignedEmployeeInterviewQuestions.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.AssignedEmployeeInterviewQuestions.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.AssignedEmployeeInterviewQuestions.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.AssignedEmployeeInterviewQuestions.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.AssignedEmployeeInterviewQuestions.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
},
"deprecated": true
}
},
"/Employees/{id}/Interviews/Categories/{categoryId}/Questions/{questionId}": {
"delete": {
"tags": [
"Employees"
],
"summary": "Delete Interview Answer",
"description": "Deletes the employee's answer to an interview question.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "EmployeesByIdInterviewsCategoriesByCategoryIdQuestionsByQuestionIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "categoryId",
"in": "path",
"description": "The Id of the interview category.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "questionId",
"in": "path",
"description": "The Id of the question.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
},
"deprecated": true
},
"put": {
"tags": [
"Employees"
],
"summary": "Upsert Interview Answer",
"description": "Adds or updates an employee interview answer.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "EmployeesByIdInterviewsCategoriesByCategoryIdQuestionsByQuestionIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "categoryId",
"in": "path",
"description": "The Id of the interview category.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "questionId",
"in": "path",
"description": "The Id of the question.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The body of the request containing the key \"Answer\". The answer is deleted if this is blank.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeInterviewAnswerRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeInterviewAnswerRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeInterviewAnswerRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeInterviewAnswerRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeInterviewAnswerRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeInterviewAnswerRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeInterviewAnswerRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeInterviewAnswerRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
},
"deprecated": true
}
},
"/Employees/{id}/language": {
"put": {
"tags": [
"Employees"
],
"summary": "Update Employee Preferred Language",
"description": "Updates the employee's preferred language to be used for localization.\n \n```` Allows roles: Service, ServiceRep, WebUserEmployee ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdLanguagePut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The request body containing the employee's preferred language code.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeLanguageRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeLanguageRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeLanguageRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeLanguageRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeLanguageRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeLanguageRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeLanguageRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeLanguageRequest"
}
}
}
},
"responses": {
"204": {
"description": ""
}
}
}
},
"/Employees/{id}/messages": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Messages",
"description": "Gets a list of messages linked to the Employee. The Messages are ordered from newest to the oldest,\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdMessagesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of messages to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of messages to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "messageActionId",
"in": "query",
"description": "Optional filter on the Id of the message action. Valid values can be found in the Message Action List. ref: /datalists/messageactions",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "messageActionTypeId",
"in": "query",
"description": "Optional filter on the Id of the message action type. Valid values can be found in the Message Action Type List. ref: /datalists/messageactiontypes",
"style": "form",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "authorSrIdent",
"in": "query",
"description": "Optional filter on the Id of the service rep who created the message.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "startDate",
"in": "query",
"description": "Optional filter on the date of the message. Any messages created on or after the date supplied will be returned.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "endDate",
"in": "query",
"description": "Optional filter on the date of the message. Any messages created on or before the date supplied will be returned.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "orderBy",
"in": "query",
"description": "Optional parameter to specify the column to order by. Valid values are 'date', 'action', 'actiondescription','authorsrident','author','id', and 'message', Defaults to 'date'",
"style": "form",
"schema": {
"maxLength": 150,
"minLength": 0,
"type": "string"
}
},
{
"name": "orderByAscending",
"in": "query",
"description": "Optional parameter to specify the direction to order by. Specify true to order ascending.",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "messageText",
"in": "query",
"description": "Optional parameter to search on the message text. To search for any message which contains a word which starts with accep, the value would be: accep*",
"style": "form",
"schema": {
"maxLength": 1000,
"minLength": 0,
"type": "string"
}
},
{
"name": "limitToPrimaryMessages",
"in": "query",
"description": "Set to true to only return the primary messages. Currently only one primary message is supported. \r\n This can be set using the endpoint PATCH employees/{id} and setting the value PrimaryMessageId.\r\n Optional filters such as start date and end date are ignored when this value is true.",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Employees"
],
"summary": "Create Message",
"description": "Creates a message and links it to the employee.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdMessagesPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The body of the request containing the information required to create the message.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateMessageWithLinkedDocumentsRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateMessageWithLinkedDocumentsRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateMessageWithLinkedDocumentsRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateMessageWithLinkedDocumentsRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateMessageWithLinkedDocumentsRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateMessageWithLinkedDocumentsRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateMessageWithLinkedDocumentsRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateMessageWithLinkedDocumentsRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
}
}
}
}
}
},
"/Employees/{id}/messages/{messageId}": {
"get": {
"tags": [
"Employees"
],
"summary": "Gets the details of a specific message.",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdMessagesByMessageIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "messageId",
"in": "path",
"description": "The Id of the message.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageSummary"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageSummary"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageSummary"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageSummary"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageSummary"
}
}
}
}
}
}
},
"/Employees/{id}/notifications/subscription/category/{notificationCategoryId}": {
"put": {
"tags": [
"Employees"
],
"summary": "Update Notification Subscription",
"description": "Updates subscription preference for a specified notification category.\r\nSince notification types are linked to both a category and a method, if the user is unsubscribed\r\nfrom the specified method they will not receive any notifications for types that are linked to them.\n \n```` Allows roles: ServiceRep, WebUserEmployee, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdNotificationsSubscriptionCategoryByNotificationCategoryIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "notificationCategoryId",
"in": "path",
"description": "The Id of the notification category to update the subscription for.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The request object containing the user's subscription preference",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateUserNotificationSubscriptionRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateUserNotificationSubscriptionRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateUserNotificationSubscriptionRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateUserNotificationSubscriptionRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateUserNotificationSubscriptionRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateUserNotificationSubscriptionRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateUserNotificationSubscriptionRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateUserNotificationSubscriptionRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/notifications/subscription/method/{notificationMethodId}": {
"put": {
"tags": [
"Employees"
],
"summary": "Update Notification Method Subscription",
"description": "Updates subscription preference for a specified notification method.\r\nSince notification types are linked to both a category and a method, if the user is unsubscribed\r\nfrom the specified method they will not receive any notifications for types that are linked to them.\n \n```` Allows roles: ServiceRep, WebUserEmployee, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdNotificationsSubscriptionMethodByNotificationMethodIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "notificationMethodId",
"in": "path",
"description": "The Id of the notification method to update the subscription for.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The request object containing the user's subscription preference",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateUserNotificationSubscriptionRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateUserNotificationSubscriptionRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateUserNotificationSubscriptionRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateUserNotificationSubscriptionRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateUserNotificationSubscriptionRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateUserNotificationSubscriptionRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateUserNotificationSubscriptionRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateUserNotificationSubscriptionRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/notifications/subscription/type/{notificationTypeId}": {
"put": {
"tags": [
"Employees"
],
"summary": "Update Notification Subscription",
"description": "Updates subscription preference for a specified notification type.\n \n```` Allows roles: ServiceRep, WebUserEmployee, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdNotificationsSubscriptionTypeByNotificationTypeIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "notificationTypeId",
"in": "path",
"description": "The Id of the notification type to update the subscription for.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The request object containing the user's subscription preference",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateUserNotificationSubscriptionRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateUserNotificationSubscriptionRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateUserNotificationSubscriptionRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateUserNotificationSubscriptionRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateUserNotificationSubscriptionRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateUserNotificationSubscriptionRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateUserNotificationSubscriptionRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateUserNotificationSubscriptionRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/notifications/unsubscriptions": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Notification Unsubscriptions",
"description": "Gets list of notification types that a user has unsubscribed to.\n \n```` Allows roles: ServiceRep, WebUserEmployee, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdNotificationsUnsubscriptionsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "Amount of list items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "Amount of list items to take. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Notifications.UserNotificationUnsubscriptionsQuery.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Notifications.UserNotificationUnsubscriptionsQuery.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Notifications.UserNotificationUnsubscriptionsQuery.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Notifications.UserNotificationUnsubscriptionsQuery.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Notifications.UserNotificationUnsubscriptionsQuery.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Notifications.UserNotificationUnsubscriptionsQuery.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Notifications.UserNotificationUnsubscriptionsQuery.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Employees/{id}/offers": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Job Offers List",
"description": "Gets a list of job offers for the employee. The list is sorted by most previously created.\n \n```` Allows roles: ServiceRep, WebUserEmployee ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdOffersGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "Skip",
"in": "query",
"description": "Amount of list items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Take",
"in": "query",
"description": "Amount of list items to take. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "IncludeAcceptedOffers",
"in": "query",
"description": "Specifies that offers that have been accepted should be included in the list.\r\nDefaults to true.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "IncludeDeclinedOffers",
"in": "query",
"description": "Specifies that offers that have been declined should be included in the list.\r\nDefaults to true.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "IncludeNewOffers",
"in": "query",
"description": "Specifies that new offers that have not been responded to by the employee should\r\nbe included in the list.\r\nDefaults to true.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "IncludeFilledOffers",
"in": "query",
"description": "Specifies that new offers for filled orders should be included on the list.\r\nAn order is filled when the number of employees assigned is the same as positions available.\r\nDefaults to true.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "IncludeCanceledOffers",
"in": "query",
"description": "Specifies that offers that have been canceled should be included in the list.\r\nDefaults to true.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "IncludeExpiredOffers",
"in": "query",
"description": "Specifies that offers that have expired should be included in the list.\r\nDefaults to true.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "Culture",
"in": "query",
"description": "Optional filter to return the translated texts in the given culture.",
"style": "form",
"schema": {
"maxLength": 20,
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeOffersQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeOffersQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeOffersQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeOffersQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeOffersQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeOffersQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeOffersQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Employees/{id}/offers/{jobOfferId}": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Job Offer Details",
"description": "Gets the details for the specified job offer.\n \n```` Allows roles: ServiceRep, WebUserEmployee ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdOffersByJobOfferIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "jobOfferId",
"in": "path",
"description": "The id of the job offer.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "culture",
"in": "query",
"description": "Returns translated texts if any in the given culture.",
"style": "form",
"schema": {
"maxLength": 20,
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeOfferDetailsQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeOfferDetailsQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeOfferDetailsQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeOfferDetailsQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeOfferDetailsQuery.Result"
}
}
}
}
}
}
},
"/Employees/{id}/onboarding/eeoSummary": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Employee Summary information used during the employee onboarding process",
"description": "\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): onboarding-eeo-read ````",
"operationId": "EmployeesByIdOnboardingEeoSummaryGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetEmployeeEeoSummary.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetEmployeeEeoSummary.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetEmployeeEeoSummary.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetEmployeeEeoSummary.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetEmployeeEeoSummary.Result"
}
}
}
}
}
}
},
"/Employees/{id}/onboarding/jobOrderCandidates": {
"put": {
"tags": [
"Employees"
],
"summary": "Adds applicant to the requested JobOrders. \r\nThis will bypass job order candidate assignment restrictions.",
"description": "\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): onboarding-write ````",
"operationId": "EmployeesByIdOnboardingJobOrderCandidatesPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "Body of the request containing information about what orders\r\n to place the employee as a candidate under",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.JobOrderCandidatesRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.JobOrderCandidatesRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.JobOrderCandidatesRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.JobOrderCandidatesRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.JobOrderCandidatesRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.JobOrderCandidatesRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.JobOrderCandidatesRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.JobOrderCandidatesRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/onboarding/logUserAction": {
"put": {
"tags": [
"Employees"
],
"summary": "Log an employee's last onboarding action",
"description": "\n \n```` Allows roles: Service ````\n \n```` Requires scope(s): onboarding-write ````",
"operationId": "EmployeesByIdOnboardingLogUserActionPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "action",
"in": "query",
"description": "Description of action taken",
"required": true,
"style": "form",
"schema": {
"maxLength": 255,
"minLength": 0,
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/onboarding/postfill": {
"post": {
"tags": [
"Employees"
],
"summary": "Runs postfill procedure to save postfill data to the employee file",
"description": "\n \n```` Allows roles: Service ````\n \n```` Requires scope(s): onboarding-write ````",
"operationId": "EmployeesByIdOnboardingPostfillPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The body of the request containing page data\r\n to be saved to the employee file.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.PostfillRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.PostfillRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.PostfillRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.PostfillRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.PostfillRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.PostfillRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.PostfillRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.PostfillRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.PerformPostfill.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.PerformPostfill.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.PerformPostfill.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.PerformPostfill.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.PerformPostfill.Result"
}
}
}
}
}
}
},
"/Employees/{id}/onboarding/prefill": {
"post": {
"tags": [
"Employees"
],
"summary": "Gets prefill data for onboarding pages.",
"description": "This is used for pages where an Applicant is the primary actor type.\n \n```` Allows roles: Service ````\n \n```` Requires scope(s): onboarding-write ````",
"operationId": "EmployeesByIdOnboardingPrefillPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The body of the request containing information\r\n about what page prefill data needs to be retrieved from the employee file.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.PrefillRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.PrefillRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.PrefillRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.PrefillRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.PrefillRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.PrefillRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.PrefillRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.PrefillRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetPrefill.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetPrefill.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetPrefill.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetPrefill.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetPrefill.Result"
}
}
}
}
}
}
},
"/employees/{id}/onboarding/syncOnboardingData": {
"post": {
"tags": [
"Employees"
],
"summary": "Refresh Searchable Workflow and Step Data.",
"description": "\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): onboarding-write ````",
"operationId": "EmployeesByIdOnboardingSyncOnboardingDataPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/onboarding/templateDetails": {
"get": {
"tags": [
"Employees"
],
"summary": "Gets the specified Employee/Applicant's template placeholder details.",
"description": "\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): onboarding-read or onboarding-write ````",
"operationId": "EmployeesByIdOnboardingTemplateDetailsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Id of the Employee/Applicant",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Queries.EmployeeOnboardingEmailTemplateDetails.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Queries.EmployeeOnboardingEmailTemplateDetails.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Queries.EmployeeOnboardingEmailTemplateDetails.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Queries.EmployeeOnboardingEmailTemplateDetails.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Queries.EmployeeOnboardingEmailTemplateDetails.Result"
}
}
}
}
}
}
},
"/Employees/{id}/onboarding/workflows": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Employee Onboarding Workflow Instances",
"description": "Gets a list of Onboarding Workflow Instances assigned to the Employee.\n \n```` Allows roles: ServiceRep, WebUserEmployee ````\n \n```` Requires scope(s): onboarding-read or onboarding-write ````",
"operationId": "EmployeesByIdOnboardingWorkflowsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "RestrictToActiveWorkflowInstances",
"in": "query",
"description": "Limits workflow results to active workflows only. \r\n A workflow is considered active if the Employee is the current actor and the workflow \r\n is not in a completed, submitted, or rejected state.",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetWorkflowInstanceListQuery.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetWorkflowInstanceListQuery.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetWorkflowInstanceListQuery.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetWorkflowInstanceListQuery.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetWorkflowInstanceListQuery.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetWorkflowInstanceListQuery.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetWorkflowInstanceListQuery.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Employees"
],
"summary": "Create Employee Onboarding Workflow Instance",
"description": "Assigns an Onboarding Workflow to the Employee.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): onboarding-write ````",
"operationId": "EmployeesByIdOnboardingWorkflowsPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The body of the request containing information about the new workflow.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.CreateWorkflowInstanceRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.CreateWorkflowInstanceRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.CreateWorkflowInstanceRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.CreateWorkflowInstanceRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.CreateWorkflowInstanceRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.CreateWorkflowInstanceRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.CreateWorkflowInstanceRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.CreateWorkflowInstanceRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.AssignWorkflowCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.AssignWorkflowCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.AssignWorkflowCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.AssignWorkflowCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.AssignWorkflowCommand.Result"
}
}
}
}
}
}
},
"/Employees/{id}/onboarding/workflows/{workflowInstanceId}": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Employee Onboarding Workflow Instance",
"description": "Gets details about the Onboarding Workflow Instance.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): onboarding-read or onboarding-write ````",
"operationId": "EmployeesByIdOnboardingWorkflowsByWorkflowInstanceIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "workflowInstanceId",
"in": "path",
"description": "The Id of the workflow instance.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetWorkflowInstanceListQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetWorkflowInstanceListQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetWorkflowInstanceListQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetWorkflowInstanceListQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetWorkflowInstanceListQuery.Result"
}
}
}
}
}
}
},
"/Employees/{id}/onboarding/workflows/{workflowInstanceId}/advance": {
"put": {
"tags": [
"Employees"
],
"summary": "Advance Onboarding Workflow Instance to the next Step",
"description": "Advances the Onboarding Workflow to the next Step or marks it as Complete if there is no next Step.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): onboarding-write ````",
"operationId": "EmployeesByIdOnboardingWorkflowsByWorkflowInstanceIdAdvancePut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "workflowInstanceId",
"in": "path",
"description": "The Id of the workflow instance.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "A request that allows you to provide a secondary actor's username",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.AdvanceWorkflowRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.AdvanceWorkflowRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.AdvanceWorkflowRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.AdvanceWorkflowRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.AdvanceWorkflowRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.AdvanceWorkflowRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.AdvanceWorkflowRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.AdvanceWorkflowRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.AdvanceWorkflowInstanceCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.AdvanceWorkflowInstanceCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.AdvanceWorkflowInstanceCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.AdvanceWorkflowInstanceCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.AdvanceWorkflowInstanceCommand.Result"
}
}
}
}
}
}
},
"/Employees/{id}/onboarding/workflows/{workflowInstanceId}/logWorkflowUpdated": {
"put": {
"tags": [
"Employees"
],
"summary": "Logs progress of the current workflow",
"description": "\n \n```` Allows roles: Service ````\n \n```` Requires scope(s): onboarding-write ````",
"operationId": "EmployeesByIdOnboardingWorkflowsByWorkflowInstanceIdLogWorkflowUpdatedPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee record",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "workflowInstanceId",
"in": "path",
"description": "The Id of the workflow instance",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "Body of the request containing information about the workflow",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.LogUserWorkflowUpdatedRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.LogUserWorkflowUpdatedRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.LogUserWorkflowUpdatedRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.LogUserWorkflowUpdatedRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.LogUserWorkflowUpdatedRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.LogUserWorkflowUpdatedRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.LogUserWorkflowUpdatedRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.LogUserWorkflowUpdatedRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/onboarding/workflows/{workflowInstanceId}/reject": {
"put": {
"tags": [
"Employees"
],
"summary": "Reject Employee Onboarding Workflow Instance",
"description": "Rejects the Instance of the Workflow assigned to the Employee.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): onboarding-write ````",
"operationId": "EmployeesByIdOnboardingWorkflowsByWorkflowInstanceIdRejectPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "workflowInstanceId",
"in": "path",
"description": "The Id of the workflow instance to reject.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The body of the request containing the reason the workflow has been rejected.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.RejectWorkflowRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.RejectWorkflowRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.RejectWorkflowRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.RejectWorkflowRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.RejectWorkflowRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.RejectWorkflowRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.RejectWorkflowRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.RejectWorkflowRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/onboarding/workflows/{workflowInstanceId}/singleSignOn": {
"get": {
"tags": [
"Employees"
],
"summary": "Creates a url used for single sign on to HrCenter",
"description": "Returns a secure query string that can be used to sign into HrCenter\n \n```` Allows roles: ServiceRep, WebUserEmployee ````\n \n```` Requires scope(s): onboarding-read or onboarding-write ````",
"operationId": "EmployeesByIdOnboardingWorkflowsByWorkflowInstanceIdSingleSignOnGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the User.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "workflowInstanceId",
"in": "path",
"description": "The Id of the workflow instance.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetSingleSignOnUrlCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetSingleSignOnUrlCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetSingleSignOnUrlCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetSingleSignOnUrlCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetSingleSignOnUrlCommand.Result"
}
}
}
}
}
}
},
"/Employees/{id}/onboarding/workflows/{workflowInstanceId}/steps": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Employee Onboarding Step Instances",
"description": "Gets a list of Step Instances for an Onboarding Workflow Instance.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): onboarding-read or onboarding-write ````",
"operationId": "EmployeesByIdOnboardingWorkflowsByWorkflowInstanceIdStepsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "workflowInstanceId",
"in": "path",
"description": "The Id of the workflow instance.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetWorkflowInstanceStepList.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetWorkflowInstanceStepList.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetWorkflowInstanceStepList.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetWorkflowInstanceStepList.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetWorkflowInstanceStepList.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetWorkflowInstanceStepList.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetWorkflowInstanceStepList.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Employees/{id}/onboarding/workflows/{workflowInstanceId}/steps/{stepInstanceId}": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Employee Onboarding Step Instance",
"description": "Gets details about the Step Instance.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): onboarding-read or onboarding-write ````",
"operationId": "EmployeesByIdOnboardingWorkflowsByWorkflowInstanceIdStepsByStepInstanceIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "workflowInstanceId",
"in": "path",
"description": "The Id of the workflow instance.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "stepInstanceId",
"in": "path",
"description": "The Id of the step instance.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetWorkflowInstanceStepList.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetWorkflowInstanceStepList.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetWorkflowInstanceStepList.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetWorkflowInstanceStepList.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetWorkflowInstanceStepList.Result"
}
}
}
}
}
},
"put": {
"tags": [
"Employees"
],
"summary": "Add Additional Step Instances Pages",
"description": "Adds additional Pages to the Step Instance.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): onboarding-write ````",
"operationId": "EmployeesByIdOnboardingWorkflowsByWorkflowInstanceIdStepsByStepInstanceIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "workflowInstanceId",
"in": "path",
"description": "The Id of the workflow instance.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "stepInstanceId",
"in": "path",
"description": "The Id of the step instance.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The body of the request containing the reason the workflow has been rejected.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.AddAdditionalPagesToStepInstanceRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.AddAdditionalPagesToStepInstanceRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.AddAdditionalPagesToStepInstanceRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.AddAdditionalPagesToStepInstanceRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.AddAdditionalPagesToStepInstanceRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.AddAdditionalPagesToStepInstanceRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.AddAdditionalPagesToStepInstanceRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.AddAdditionalPagesToStepInstanceRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/onboarding/workflows/{workflowInstanceId}/steps/{stepInstanceId}/nextStep": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Employee Onboarding Step Instance Next Step",
"description": "Gets the next step for the Step Instance based on the Workflow settings in HRCenter.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): onboarding-read or onboarding-write ````",
"operationId": "EmployeesByIdOnboardingWorkflowsByWorkflowInstanceIdStepsByStepInstanceIdNextStepGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "workflowInstanceId",
"in": "path",
"description": "The Id of the workflow instance.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "stepInstanceId",
"in": "path",
"description": "The Id of the step instance.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetStepInstanceNextStepQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetStepInstanceNextStepQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetStepInstanceNextStepQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetStepInstanceNextStepQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetStepInstanceNextStepQuery.Result"
}
}
}
}
}
}
},
"/Employees/{id}/onboarding/workflows/{workflowInstanceId}/steps/{stepInstanceId}/pages": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Employee Onboarding Page Instances",
"description": "Gets a list of Page Instances for the Onboarding Step Instance.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): onboarding-read or onboarding-write ````",
"operationId": "EmployeesByIdOnboardingWorkflowsByWorkflowInstanceIdStepsByStepInstanceIdPagesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "workflowInstanceId",
"in": "path",
"description": "The Id of the workflow instance.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "stepInstanceId",
"in": "path",
"description": "The Id of the step instance.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetStepInstancePageInstanceListQuery.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetStepInstancePageInstanceListQuery.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetStepInstancePageInstanceListQuery.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetStepInstancePageInstanceListQuery.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetStepInstancePageInstanceListQuery.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetStepInstancePageInstanceListQuery.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetStepInstancePageInstanceListQuery.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Employees/{id}/onboarding/workflows/{workflowInstanceId}/steps/{stepInstanceId}/pages/{pageInstanceId}": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Employee Onboarding Page Instance",
"description": "Gets details about the Onboarding Workflow Page Instance.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): onboarding-read or onboarding-write ````",
"operationId": "EmployeesByIdOnboardingWorkflowsByWorkflowInstanceIdStepsByStepInstanceIdPagesByPageInstanceIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "workflowInstanceId",
"in": "path",
"description": "The Id of the workflow instance.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "stepInstanceId",
"in": "path",
"description": "The Id of the step instance.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "pageInstanceId",
"in": "path",
"description": "The Id of the page instance.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetStepInstancePageInstanceListQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetStepInstancePageInstanceListQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetStepInstancePageInstanceListQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetStepInstancePageInstanceListQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetStepInstancePageInstanceListQuery.Result"
}
}
}
}
}
}
},
"/Employees/{id}/onboarding/workflows/{workflowInstanceId}/steps/{stepInstanceId}/pages/{pageInstanceId}/forceComplete": {
"put": {
"tags": [
"Employees"
],
"summary": "Force Complete Employee Onboarding Workflow Page Instance",
"description": "Relays request to Onboarding Application to mark a 3rd Party Page Complete. \r\nAllows applicant to complete the step if the 3rd party integration is down.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): onboarding-write ````",
"operationId": "EmployeesByIdOnboardingWorkflowsByWorkflowInstanceIdStepsByStepInstanceIdPagesByPageInstanceIdForceCompletePut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "workflowInstanceId",
"in": "path",
"description": "Workflow that contains the page to force complete.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "stepInstanceId",
"in": "path",
"description": "Step within the workflow that contains the page to force complete.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "pageInstanceId",
"in": "path",
"description": "Specific page to force complete.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.ForceUserBlockCompleteCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.ForceUserBlockCompleteCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.ForceUserBlockCompleteCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.ForceUserBlockCompleteCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.ForceUserBlockCompleteCommand.Result"
}
}
}
}
}
}
},
"/Employees/{id}/onboarding/workflows/{workflowInstanceId}/steps/{stepInstanceId}/pages/{pageInstanceId}/questions": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Employee Onboarding Workflow Page Instance Questions",
"description": "Gets a list of Questions for the Page Instance and the Employee's responses to them.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): onboarding-read or onboarding-write ````",
"operationId": "EmployeesByIdOnboardingWorkflowsByWorkflowInstanceIdStepsByStepInstanceIdPagesByPageInstanceIdQuestionsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "workflowInstanceId",
"in": "path",
"description": "The Id of the workflow instance.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "stepInstanceId",
"in": "path",
"description": "The Id of the step instance.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "pageInstanceId",
"in": "path",
"description": "The Id of the page instance.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetPageInstanceQuestionListQuery.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetPageInstanceQuestionListQuery.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetPageInstanceQuestionListQuery.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetPageInstanceQuestionListQuery.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetPageInstanceQuestionListQuery.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetPageInstanceQuestionListQuery.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetPageInstanceQuestionListQuery.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Employees/{id}/onboarding/workflows/{workflowInstanceId}/steps/{stepInstanceId}/pages/{pageInstanceId}/rejectPage": {
"put": {
"tags": [
"Employees"
],
"summary": "Reject Employee Onboarding Workflow Page Instance",
"description": "Rejects a page within a step, allowing the applicant to complete the step.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): onboarding-write ````",
"operationId": "EmployeesByIdOnboardingWorkflowsByWorkflowInstanceIdStepsByStepInstanceIdPagesByPageInstanceIdRejectPagePut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "workflowInstanceId",
"in": "path",
"description": "Workflow that contains the page to reject.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "stepInstanceId",
"in": "path",
"description": "Step within the workflow that contains the page to reject.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "pageInstanceId",
"in": "path",
"description": "Specific page to reject.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "rejectionReason",
"in": "query",
"description": "Reason for the rejection of the page.",
"style": "form",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.RejectUserBlockCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.RejectUserBlockCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.RejectUserBlockCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.RejectUserBlockCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.RejectUserBlockCommand.Result"
}
}
}
}
}
}
},
"/Employees/{id}/onboarding/workflows/{workflowInstanceId}/steps/{stepInstanceId}/pages/{pageInstanceId}/signingUrl": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Employee Onboarding Workflow Page Instance Signing Url",
"description": "Gets a temporarily valid Url for the Service Rep to use to be able to review and sign a Document if a Service Rep signature is required.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): onboarding-read or onboarding-write ````",
"operationId": "EmployeesByIdOnboardingWorkflowsByWorkflowInstanceIdStepsByStepInstanceIdPagesByPageInstanceIdSigningUrlGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "workflowInstanceId",
"in": "path",
"description": "The Id of the workflow instance.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "stepInstanceId",
"in": "path",
"description": "The Id of the step instance.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "pageInstanceId",
"in": "path",
"description": "The Id of the page instance.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetUrlForDocumentSigningQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetUrlForDocumentSigningQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetUrlForDocumentSigningQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetUrlForDocumentSigningQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetUrlForDocumentSigningQuery.Result"
}
}
}
}
}
}
},
"/Employees/{id}/onboarding/workflows/{workflowInstanceId}/steps/{stepInstanceId}/requiredSignatures": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Employee Onboarding Step Instance Required Signatures",
"description": "Gets a list of Documents that require a Signature by a Service Rep in order for the Step Instance to be able to be completed.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): onboarding-read or onboarding-write ````",
"operationId": "EmployeesByIdOnboardingWorkflowsByWorkflowInstanceIdStepsByStepInstanceIdRequiredSignaturesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "workflowInstanceId",
"in": "path",
"description": "The Id of the workflow instance.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "stepInstanceId",
"in": "path",
"description": "The Id of the step instance.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetDocumentsToSignForStepQuery.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetDocumentsToSignForStepQuery.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetDocumentsToSignForStepQuery.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetDocumentsToSignForStepQuery.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetDocumentsToSignForStepQuery.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetDocumentsToSignForStepQuery.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetDocumentsToSignForStepQuery.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Employees/{id}/onboarding/workflows/{workflowInstanceId}/steps/{stepInstanceId}/unlock": {
"put": {
"tags": [
"Employees"
],
"summary": "Unlock Employee Onboarding Workflow Step Instance",
"description": "Allows the Step Instance to be edited again by the Employee if it has been Submitted but not Completed.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): onboarding-write ````",
"operationId": "EmployeesByIdOnboardingWorkflowsByWorkflowInstanceIdStepsByStepInstanceIdUnlockPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "workflowInstanceId",
"in": "path",
"description": "The Id of the workflow instance.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "stepInstanceId",
"in": "path",
"description": "The Id of the step instance.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/paychecks": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Employee Paycheck List",
"description": "Returns a list of paychecks issued to the employee along with summary information about the checks. The list is ordered by the CheckDate descending.\n \n```` Allows roles: ServiceRep, Service, WebUserEmployee ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdPaychecksGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of checks to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of checks to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "queryType",
"in": "query",
"description": "This determines what type of checks get returned. Current supported values are 1 for Posted checks, 2 for Staged checks, and 3 for Posted checks that should be shown to an employee.",
"style": "form",
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Enums.PaycheckQueryTypes"
}
},
{
"name": "bankAccountId",
"in": "query",
"description": "An optional parameter that will restrict the query to only checks issued from the specified bank account. Valid Bank Accounts can be found in the Bank Accounts Datalist.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "startingCheckDate",
"in": "query",
"description": "An optional parameter that will restrict the query to only checks with a check date greater than or equal to the specified date.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "endingCheckDate",
"in": "query",
"description": "An optional parameter that will restrict the query to only checks with a check date less than or equal to the specified date.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "payrollRunId",
"in": "query",
"description": "An optional parameter that will restrict the query to only checks from the specified payroll run.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "checkNumber",
"in": "query",
"description": "An optional parameter that will restrict the query to only checks with the specified check number.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "paycheckId",
"in": "query",
"description": "An optional parameter that will restrict the query to only the check with the specified Id.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "grossPay",
"in": "query",
"description": "An optional parameter that will restrict the query to only checks with the specified gross pay.",
"style": "form",
"schema": {
"type": "number",
"format": "double"
}
},
{
"name": "netPay",
"in": "query",
"description": "An optional parameter that will restrict the query to only checks with the specified net pay.",
"style": "form",
"schema": {
"type": "number",
"format": "double"
}
},
{
"name": "employerId",
"in": "query",
"description": "An optional parameter that will restrict the query to only checks issued by the specified employer. Valid Employers can be found in the Employers Datalist.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "orderBy",
"in": "query",
"description": "An optional parameter that will sort the query by the specified property. Valid properties are those that come back on the result object.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "orderByAscending",
"in": "query",
"description": "An optional parameter that will change whether the field the query is ordered by is ordered ascending or descending.",
"style": "form",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeePaycheckListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeePaycheckListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeePaycheckListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeePaycheckListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeePaycheckListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeePaycheckListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeePaycheckListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Employees/{id}/paychecks/{paycheckId}": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Employee Paycheck Details",
"description": "Returns detailed information about the specified Paycheck including lists of Adjustments, Taxes, and Transactions.\n \n```` Allows roles: ServiceRep, WebUserEmployee ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdPaychecksByPaycheckIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "paycheckId",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "includeEmployerPaidBenefits",
"in": "query",
"description": "If set to true, then benefit adjustments will be included in the list of adjustments returned.",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "includeEmployerTaxes",
"in": "query",
"description": "If set to true, then both employee and employer paid taxes will be included in the list of taxes returned.",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Paychecks.PaycheckDetailsQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Paychecks.PaycheckDetailsQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Paychecks.PaycheckDetailsQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Paychecks.PaycheckDetailsQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Paychecks.PaycheckDetailsQuery.Result"
}
}
}
}
}
}
},
"/Employees/{id}/paychecks/{paycheckId}/PayStubBytes": {
"get": {
"tags": [
"Employees"
],
"summary": "Generate PayStub Pdf",
"description": "Generates a PDF of a specified PayStub for the employee.\n \n```` Allows roles: ServiceRep, WebUserEmployee ````\n \n```` Requires scope(s): Reserved For TempWorks' Products Only ````",
"operationId": "EmployeesByIdPaychecksByPaycheckIdPayStubBytesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "paycheckId",
"in": "path",
"description": "The ID of the paycheck to be downloaded",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "string",
"format": "binary"
}
},
"application/json": {
"schema": {
"type": "string",
"format": "binary"
}
},
"text/json": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
}
}
}
},
"/Employees/{id}/PayHistory/ACHHistory": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Employee ACH History List",
"description": "Returns a list of paychecks issued to the employee via ACH. The list is ordered by the ACHFeedHistoryId descending.\n \n```` Allows roles: ServiceRep, Service, WebUserEmployee ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdPayHistoryACHHistoryGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of checks to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of checks to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "orderBy",
"in": "query",
"description": "An optional parameter that will sort the query by the specified property. Valid properties are those that come back on the result object.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "orderByAscending",
"in": "query",
"description": "An optional parameter that will change whether the field the query is ordered by is ordered ascending or descending.",
"style": "form",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeACHHistoryListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeACHHistoryListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeACHHistoryListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeACHHistoryListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeACHHistoryListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeACHHistoryListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeACHHistoryListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Employees/{id}/PayHistory/AdjustmentHistory": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Employee Adjustment History List",
"description": "Returns a list of pay adjustments issued to the employee. The list is ordered by the AdjustmentTypeID descending.\n \n```` Allows roles: ServiceRep, Service, WebUserEmployee ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdPayHistoryAdjustmentHistoryGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of checks to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of checks to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "orderBy",
"in": "query",
"description": "An optional parameter that will sort the query by the specified property. Valid properties are those that come back on the result object.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "orderByAscending",
"in": "query",
"description": "An optional parameter that will change whether the field the query is ordered by is ordered ascending or descending.",
"style": "form",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeAdjustmentHistoryListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeAdjustmentHistoryListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeAdjustmentHistoryListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeAdjustmentHistoryListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeAdjustmentHistoryListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeAdjustmentHistoryListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeAdjustmentHistoryListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Employees/{id}/PayHistory/PayCardHistory": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Employee Pay Card History List",
"description": "Returns a list of paychecks issued to the employee via Pay Card. The list is ordered by the PaycardCheckID descending.\n \n```` Allows roles: ServiceRep, Service, WebUserEmployee ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdPayHistoryPayCardHistoryGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of checks to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of checks to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "orderBy",
"in": "query",
"description": "An optional parameter that will sort the query by the specified property. Valid properties are those that come back on the result object.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "orderByAscending",
"in": "query",
"description": "An optional parameter that will change whether the field the query is ordered by is ordered ascending or descending.",
"style": "form",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeePayCardHistoryListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeePayCardHistoryListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeePayCardHistoryListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeePayCardHistoryListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeePayCardHistoryListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeePayCardHistoryListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeePayCardHistoryListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Employees/{id}/PayHistory/TaxesToDateHistory": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Employee Taxes To Date History List",
"description": "Returns a list of taxes to date issued to the employee. The list is ordered by the ID descending.\n \n```` Allows roles: ServiceRep, Service, WebUserEmployee ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdPayHistoryTaxesToDateHistoryGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "orderBy",
"in": "query",
"description": "An optional parameter that will sort the query by the specified property. Valid properties are those that come back on the result object.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "orderByAscending",
"in": "query",
"description": "An optional parameter that will change whether the field the query is ordered by is ordered ascending or descending.",
"style": "form",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeTaxesToDateHistoryListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeTaxesToDateHistoryListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeTaxesToDateHistoryListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeTaxesToDateHistoryListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeTaxesToDateHistoryListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeTaxesToDateHistoryListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeTaxesToDateHistoryListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Employees/{id}/PayHistory/TransactionHistory": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Employee Transaction History List",
"description": "Returns a list of items issued to the employee. The list is ordered by the TransactionId descending.\n \n```` Allows roles: ServiceRep, Service, WebUserEmployee ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdPayHistoryTransactionHistoryGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "orderBy",
"in": "query",
"description": "An optional parameter that will sort the query by the specified property. Valid properties are those that come back on the result object.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "orderByAscending",
"in": "query",
"description": "An optional parameter that will change whether the field the query is ordered by is ordered ascending or descending.",
"style": "form",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeTransactionHistoryListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeTransactionHistoryListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeTransactionHistoryListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeTransactionHistoryListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeTransactionHistoryListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeTransactionHistoryListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeTransactionHistoryListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Employees/{id}/PayrollSetup": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Payroll Setup",
"description": "Gets payroll setup information for the specified employee.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdPayrollSetupGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeePayrollSetupQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeePayrollSetupQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeePayrollSetupQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeePayrollSetupQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeePayrollSetupQuery.Result"
}
}
}
}
}
}
},
"/Employees/{id}/payTransparency": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Employee Pay Transparency",
"description": "Gets the employee's pay transparency information.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdPayTransparencyGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeePayTransparencyListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeePayTransparencyListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeePayTransparencyListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeePayTransparencyListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeePayTransparencyListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeePayTransparencyListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeePayTransparencyListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Employees"
],
"summary": "Create Employee Pay Transparency",
"description": "Allows a user with the correct permission to create a Pay Transparency record for an employee.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdPayTransparencyPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The request containing the EEO field values.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreatePayTransparencyRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreatePayTransparencyRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreatePayTransparencyRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreatePayTransparencyRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreatePayTransparencyRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreatePayTransparencyRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreatePayTransparencyRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreatePayTransparencyRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created"
}
}
}
},
"/Employees/{id}/payTransparency/{state}": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Employee Pay Transparency by State",
"description": "Gets the employee's pay transparency information for a given state.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdPayTransparencyByStateGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "state",
"in": "path",
"description": "The state you want to retrieve pay transparency information for",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeePayTransparencyQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeePayTransparencyQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeePayTransparencyQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeePayTransparencyQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeePayTransparencyQuery.Result"
}
}
}
}
}
},
"put": {
"tags": [
"Employees"
],
"summary": "Update Employee Pay Transparency",
"description": "Allows a user with the correct permission to update a pay transparency for an employee.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdPayTransparencyByStatePut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "state",
"in": "path",
"description": "The state pay transparency will be updated for",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The request containing the updated pay transparency values.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdatePayTransparencyRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdatePayTransparencyRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdatePayTransparencyRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdatePayTransparencyRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdatePayTransparencyRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdatePayTransparencyRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdatePayTransparencyRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdatePayTransparencyRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/payTransparency/metadata": {
"get": {
"tags": [
"Employees"
],
"summary": "Employee Pay Transparency Meta data",
"description": "Returns information about the current state of the employee's pay transparency and what actions the user can take with it.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdPayTransparencyMetadataGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeEEOMetaQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeEEOMetaQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeEEOMetaQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeEEOMetaQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeEEOMetaQuery.Result"
}
}
}
}
}
}
},
"/Employees/{id}/References": {
"get": {
"tags": [
"Employees"
],
"summary": "Get References",
"description": "Gets a list of references for the specified employee.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdReferencesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of references to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of references to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.References.EmployeeReferencesQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.References.EmployeeReferencesQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.References.EmployeeReferencesQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.References.EmployeeReferencesQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.References.EmployeeReferencesQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.References.EmployeeReferencesQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.References.EmployeeReferencesQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Employees"
],
"summary": "Create Reference",
"description": "Creates a new reference for the specified employee.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdReferencesPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The reference to create.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeReferenceRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeReferenceRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeReferenceRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeReferenceRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeReferenceRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeReferenceRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeReferenceRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeReferenceRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.References.CreateEmployeeReferenceCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.References.CreateEmployeeReferenceCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.References.CreateEmployeeReferenceCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.References.CreateEmployeeReferenceCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.References.CreateEmployeeReferenceCommand.Result"
}
}
}
}
}
}
},
"/Employees/{id}/References/{referenceId}": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Reference",
"description": "Gets details about a reference for the specified employee.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdReferencesByReferenceIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "referenceId",
"in": "path",
"description": "The Id of the reference.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.References.EmployeeReferencesQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.References.EmployeeReferencesQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.References.EmployeeReferencesQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.References.EmployeeReferencesQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.References.EmployeeReferencesQuery.Result"
}
}
}
}
}
},
"delete": {
"tags": [
"Employees"
],
"summary": "Delete Reference",
"description": "Deletes a reference for the specified employee.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdReferencesByReferenceIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "referenceId",
"in": "path",
"description": "The Id of the reference.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
},
"put": {
"tags": [
"Employees"
],
"summary": "Update Reference",
"description": "Updates information about a reference for the specified employee.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdReferencesByReferenceIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "referenceId",
"in": "path",
"description": "The Id of the reference.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The request body containing the updated reference values.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeReferenceRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeReferenceRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeReferenceRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeReferenceRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeReferenceRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeReferenceRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeReferenceRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeReferenceRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/References/{referenceId}/Questions": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Reference Questions",
"description": "Gets questions and answers for the specified reference.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdReferencesByReferenceIdQuestionsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "referenceId",
"in": "path",
"description": "The Id of the reference.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of questions to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of questions to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.References.EmployeeReferenceQuestionsQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.References.EmployeeReferenceQuestionsQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.References.EmployeeReferenceQuestionsQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.References.EmployeeReferenceQuestionsQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.References.EmployeeReferenceQuestionsQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.References.EmployeeReferenceQuestionsQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.References.EmployeeReferenceQuestionsQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"put": {
"tags": [
"Employees"
],
"summary": "Update Reference Questions",
"description": "Updates answers for the specified questions for the specified reference.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdReferencesByReferenceIdQuestionsPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "referenceId",
"in": "path",
"description": "The Id of the reference.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The request body containing the updated questions.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeReferenceQuestionsRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeReferenceQuestionsRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeReferenceQuestionsRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeReferenceQuestionsRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeReferenceQuestionsRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeReferenceQuestionsRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeReferenceQuestionsRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeReferenceQuestionsRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/RequiredDocuments": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Employee Required Documents",
"description": "Get a page list of required employee documents ordered by active, expired, expiring soon, missing status\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdRequiredDocumentsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee required document.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "sortBy",
"in": "query",
"description": "Sort By field, currently only supports RequiredDocumentType or DateCreated.",
"style": "form",
"schema": {
"type": "string",
"default": "DateCreated"
}
},
{
"name": "sortByAscending",
"in": "query",
"description": "true for sorting by ascending",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "filterByStatus",
"in": "query",
"description": "Filter by status of required document, currnetly its None, Active, Inactive, Expired, ExpiringSoon, Missing",
"style": "form",
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Enums.FilterByStatusType"
}
},
{
"name": "filterByRequiredDocumentTypeId",
"in": "query",
"description": "The required document type id to filter on.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeRequiredDocumentList.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeRequiredDocumentList.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeRequiredDocumentList.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeRequiredDocumentList.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeRequiredDocumentList.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeRequiredDocumentList.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeRequiredDocumentList.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Employees"
],
"summary": "Create Employee Required Document",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdRequiredDocumentsPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The Required Document data to insert.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeRequiredDocumentRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeRequiredDocumentRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeRequiredDocumentRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeRequiredDocumentRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeRequiredDocumentRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeRequiredDocumentRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeRequiredDocumentRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeRequiredDocumentRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.CreateEmployeeRequiredDocument.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.CreateEmployeeRequiredDocument.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.CreateEmployeeRequiredDocument.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.CreateEmployeeRequiredDocument.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.CreateEmployeeRequiredDocument.Result"
}
}
}
}
}
}
},
"/Employees/{id}/RequiredDocuments/{employeeRequiredDocumentId}": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Employee Required Document Details",
"description": "Get a single Employee Required Document\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdRequiredDocumentsByEmployeeRequiredDocumentIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee required document.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "employeeRequiredDocumentId",
"in": "path",
"description": "The Id of the employee required document.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeRequiredDocumentDetails.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeRequiredDocumentDetails.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeRequiredDocumentDetails.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeRequiredDocumentDetails.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeRequiredDocumentDetails.Result"
}
}
}
}
}
},
"put": {
"tags": [
"Employees"
],
"summary": "Update Employee Required Document",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdRequiredDocumentsByEmployeeRequiredDocumentIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "employeeRequiredDocumentId",
"in": "path",
"description": "The Id of the employee required document",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The Required Document data to update",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeRequiredDocumentRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeRequiredDocumentRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeRequiredDocumentRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeRequiredDocumentRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeRequiredDocumentRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeRequiredDocumentRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeRequiredDocumentRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeRequiredDocumentRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
},
"delete": {
"tags": [
"Employees"
],
"summary": "Deletes the employee required document.",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdRequiredDocumentsByEmployeeRequiredDocumentIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Employee Id",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "employeeRequiredDocumentId",
"in": "path",
"description": "Employee Required Document Id",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/resume": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Resume",
"description": "Gets the current resume version for the employee\n \n```` Allows roles: ServiceRep, WebUserEmployee, WebUserContact, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdResumeGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeResumeQuery.Model"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeResumeQuery.Model"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeResumeQuery.Model"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeResumeQuery.Model"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeResumeQuery.Model"
}
}
}
}
}
},
"post": {
"tags": [
"Employees"
],
"summary": "Upload Resume",
"description": "Uploads a resume to the employee, replacing the current version.\n \n```` Allows roles: Service, ServiceRep, WebUserEmployee, WebUserContact ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdResumePost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"201": {
"description": "Id of the new document",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.UploadEmployeeResumeCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.UploadEmployeeResumeCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.UploadEmployeeResumeCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.UploadEmployeeResumeCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.UploadEmployeeResumeCommand.Result"
}
}
}
}
}
}
},
"/Employees/{id}/Status": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Hiring Information",
"description": "Gets hiring information about the specified employee.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdStatusGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeStatusInformationQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeStatusInformationQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeStatusInformationQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeStatusInformationQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeStatusInformationQuery.Result"
}
}
}
}
}
},
"post": {
"tags": [
"Employees"
],
"summary": "Update Employee Status",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdStatusPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The status change details.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.StatusChange.StatusChangeApiRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.StatusChange.StatusChangeApiRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.StatusChange.StatusChangeApiRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.StatusChange.StatusChangeApiRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.StatusChange.StatusChangeApiRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.StatusChange.StatusChangeApiRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.StatusChange.StatusChangeApiRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.StatusChange.StatusChangeApiRequest"
}
}
}
},
"responses": {
"200": {
"description": "Status Changed",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeStatusUpdateCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeStatusUpdateCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeStatusUpdateCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeStatusUpdateCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeStatusUpdateCommand.Result"
}
}
}
},
"202": {
"description": "Status Changed and Additional Actions are staged for execution or had errors that require additional attention.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeStatusUpdateCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeStatusUpdateCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeStatusUpdateCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeStatusUpdateCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeStatusUpdateCommand.Result"
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/Employees/{id}/Status/{newEmployeeStatusId}/metadata": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Employee Status Change Metadata",
"description": "Returns the metadata regarding the status change for an Employee. \r\n This includes information regarding the additional actions, validation, and the current state of the prerequisites for the status change.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdStatusByNewEmployeeStatusIdMetadataGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "newEmployeeStatusId",
"in": "path",
"description": "The Id of the new employee status.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
},
{
"name": "returnAllPrerequisites",
"in": "query",
"description": "When true, all dynamic validation results are returned regardless of error or not. \r\n When false, only the prerequisites that have had errors are returned. Defaults to false.",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "returnAllAdditionalActions",
"in": "query",
"description": "When true, both required and optional additional actions are returned. \r\n When false, only additional actions that are optional are returned. Defaults to true.",
"style": "form",
"schema": {
"type": "boolean",
"default": true
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.StatusChange.OriginStatusChangeMetadataQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.StatusChange.OriginStatusChangeMetadataQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.StatusChange.OriginStatusChangeMetadataQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.StatusChange.OriginStatusChangeMetadataQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.StatusChange.OriginStatusChangeMetadataQuery.Result"
}
}
}
}
}
}
},
"/Employees/{id}/Summary": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Summary",
"description": "Gets summary information about the specified employee.\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdSummaryGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeSummaryQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeSummaryQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeSummaryQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeSummaryQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeSummaryQuery.Result"
}
}
}
}
}
}
},
"/Employees/{id}/tasks": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Employee Tasks",
"description": "Returns the list of tasks linked to the employee and belonging to the current user.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): (employee-read or employee-write) and (task-read or task-write) ````",
"operationId": "EmployeesByIdTasksGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "TaskQueryType",
"in": "query",
"required": true,
"style": "form",
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Enums.TaskQueryTypes"
}
},
{
"name": "Skip",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Take",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "StartDueDate",
"in": "query",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "EndDueDate",
"in": "query",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "Priority",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "IncludeNullDueDates",
"in": "query",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "FilterText",
"in": "query",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "AssignedToServiceRepId",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "TeamId",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "CreatedByServiceRepId",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "IsPinned",
"in": "query",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "StartDateArchived",
"in": "query",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "EndDateArchived",
"in": "query",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "OrderBy",
"in": "query",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "OrderByAscending",
"in": "query",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "Tags",
"in": "query",
"style": "form",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Tasks.TaskListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Tasks.TaskListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Tasks.TaskListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Tasks.TaskListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Tasks.TaskListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Tasks.TaskListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Tasks.TaskListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Employees"
],
"summary": "Create Employee Task",
"description": "Creates a task and links it to the employee.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write and task-write ````",
"operationId": "EmployeesByIdTasksPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The body of the request containing the information required to create the task.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateEntityTaskRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateEntityTaskRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateEntityTaskRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateEntityTaskRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateEntityTaskRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateEntityTaskRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateEntityTaskRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateEntityTaskRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.CreateTaskCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.CreateTaskCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.CreateTaskCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.CreateTaskCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.CreateTaskCommand.Result"
}
}
}
}
}
}
},
"/Employees/{id}/tasks/{taskId}": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Employee Task Details",
"description": "Gets more detailed information about a task pertaining to the employee.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): (employee-read or employee-write) and (task-read or task-write) ````",
"operationId": "EmployeesByIdTasksByTaskIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.TaskDetailsQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.TaskDetailsQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.TaskDetailsQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.TaskDetailsQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.TaskDetailsQuery.Result"
}
}
}
}
}
},
"put": {
"tags": [
"Employees"
],
"summary": "Update Employee Task",
"description": "Updates a task linked to the employee.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write and task-write ````",
"operationId": "EmployeesByIdTasksByTaskIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The body of the request containing the updated task details.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.UpdateTaskRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.UpdateTaskRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.UpdateTaskRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.UpdateTaskRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.UpdateTaskRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.UpdateTaskRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.UpdateTaskRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.UpdateTaskRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/tasks/{taskId}/archive": {
"put": {
"tags": [
"Employees"
],
"summary": "Archive Employee Task",
"description": "Archives the task linked to the employee.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): employee-write and task-write ````",
"operationId": "EmployeesByIdTasksByTaskIdArchivePut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/tasks/{taskId}/assign": {
"put": {
"tags": [
"Employees"
],
"summary": "Assign Employee Task",
"description": "Assigns the task linked to the employee.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): task-write ````",
"operationId": "EmployeesByIdTasksByTaskIdAssignPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The body of the request containing the new assignment details for the task.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/tasks/{taskId}/messages": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Employee Task Messages List",
"description": "Returns the list of messages linked to the task.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): task-read or task-write ````",
"operationId": "EmployeesByIdTasksByTaskIdMessagesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Employees"
],
"summary": "Create Employee Task Message",
"description": "Creates a message and links it to the Task as well as any related Entities.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): task-read or task-write ````",
"operationId": "EmployeesByIdTasksByTaskIdMessagesPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The body of the message containing the new message details.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
}
}
}
}
}
},
"/Employees/{id}/tasks/{taskId}/messages/{messageId}": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Employee Task Message Details",
"description": "Returns details about the message.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): task-read or task-write ````",
"operationId": "EmployeesByIdTasksByTaskIdMessagesByMessageIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "messageId",
"in": "path",
"description": "The Id of the message.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageSummary"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageSummary"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageSummary"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageSummary"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageSummary"
}
}
}
}
}
}
},
"/Employees/{id}/tasks/{taskId}/pin": {
"put": {
"tags": [
"Employees"
],
"summary": "Pin Employee Task",
"description": "Pins the task linked to the employee.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): employee-write and task-write ````",
"operationId": "EmployeesByIdTasksByTaskIdPinPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/tasks/{taskId}/unarchive": {
"put": {
"tags": [
"Employees"
],
"summary": "Unarchive Employee Task",
"description": "Unarchives the task linked to the employee.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): employee-write and task-write ````",
"operationId": "EmployeesByIdTasksByTaskIdUnarchivePut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/tasks/{taskId}/unpin": {
"put": {
"tags": [
"Employees"
],
"summary": "Unpin Employee Task",
"description": "s the task linked to the employee.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): employee-write and task-write ````",
"operationId": "EmployeesByIdTasksByTaskIdUnpinPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/taxes": {
"get": {
"tags": [
"Employees"
],
"summary": "Get employee taxes.",
"description": "Gets a list of employee taxes ordered by juris name in ascending order.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdTaxesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of taxes to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of taxes to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeTaxList.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeTaxList.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeTaxList.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeTaxList.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeTaxList.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeTaxList.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeTaxList.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Employees"
],
"summary": "Create employee tax.",
"description": "Creates an employee tax.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdTaxesPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The body of the request containing the required information to create the employee tax.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeTaxRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeTaxRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeTaxRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeTaxRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeTaxRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeTaxRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeTaxRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeTaxRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.CreateEmployeeTax.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.CreateEmployeeTax.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.CreateEmployeeTax.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.CreateEmployeeTax.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.CreateEmployeeTax.Result"
}
}
}
}
}
}
},
"/Employees/{id}/taxes/{employeeTaxId}": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Employee taxes details",
"description": "Get details for the specified employee tax.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdTaxesByEmployeeTaxIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "employeeTaxId",
"in": "path",
"description": "The Id of the employee tax.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeTax.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeTax.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeTax.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeTax.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeTax.Result"
}
}
}
}
}
},
"put": {
"tags": [
"Employees"
],
"summary": "Update employee tax.",
"description": "Updates an employee tax.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdTaxesByEmployeeTaxIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "employeeTaxId",
"in": "path",
"description": "The Id of the employee tax.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The body of the request containing the required information to update the employee tax.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeTaxRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeTaxRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeTaxRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeTaxRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeTaxRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeTaxRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeTaxRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeTaxRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.CreateEmployeeTax.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.CreateEmployeeTax.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.CreateEmployeeTax.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.CreateEmployeeTax.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.CreateEmployeeTax.Result"
}
}
}
}
}
}
},
"/Employees/{id}/taxes/{employeeTaxId}/validate": {
"put": {
"tags": [
"Employees"
],
"summary": "Validate update employee tax.",
"description": "Validates whether the specified request could be used to update an employee tax.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdTaxesByEmployeeTaxIdValidatePut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "employeeTaxId",
"in": "path",
"description": "The Id of the employee tax.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The body of the request containing the required information to validate the employee tax.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeTaxRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeTaxRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeTaxRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeTaxRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeTaxRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeTaxRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeTaxRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeTaxRequest"
}
}
}
},
"responses": {
"200": {
"description": "Validation passes with no errors."
},
"400": {
"description": "Invalid Request."
},
"404": {
"description": "Specified Employee id is not valid or is currenlty not visible."
},
"409": {
"description": "The specified combination of Juris or Compatible Juris and Employer already exists."
}
}
}
},
"/Employees/{id}/taxes/validate": {
"put": {
"tags": [
"Employees"
],
"summary": "Validates employee tax.",
"description": "Validates whether the specified combination of jurisdiction and employer\r\ncould be used to create an employee tax.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdTaxesValidatePut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The body of the request containing the required information to validate the employee tax.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeTaxRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeTaxRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeTaxRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeTaxRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeTaxRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeTaxRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeTaxRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeTaxRequest"
}
}
}
},
"responses": {
"200": {
"description": "Validation passes with no errors."
},
"400": {
"description": "Invalid Request."
},
"404": {
"description": "Specified Employee id is not valid or is currenlty not visible."
},
"409": {
"description": "The specified combination of Juris or Compatible Juris and Employer already exists."
}
}
}
},
"/Employees/{id}/temporaryMailingAddress": {
"put": {
"tags": [
"Employees"
],
"summary": "Update Temporary Mailing Address",
"description": "Updates the specified employee's temporary mailing address. If the address is in the United States, the system will validate\r\nit against the address standardization service. This validation can be bypassed by setting BypassAddressValidationService to true.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdTemporaryMailingAddressPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The request body containing the updated address values.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeTemporaryMailingAddressRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeTemporaryMailingAddressRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeTemporaryMailingAddressRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeTemporaryMailingAddressRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeTemporaryMailingAddressRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeTemporaryMailingAddressRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeTemporaryMailingAddressRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeTemporaryMailingAddressRequest"
}
}
}
},
"responses": {
"204": {
"description": "The request succeeded."
},
"520": {
"description": "The address standardization service is encountering server issues. Try again later."
},
"521": {
"description": "The address standardization service is encountering issues with the request."
}
}
}
},
"/Employees/{id}/webtimecards": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Employee Web Timecards",
"description": "Returns Web timecards for an employee.\r\nThe daily totals will be included in the response. You will need to make a call to the Get Employee Web Timecard Details endpoint in order to obtain the web timecard template type.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): webtimecard-read or webtimecard-write ````",
"operationId": "EmployeesByIdWebtimecardsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "AssignmentId",
"in": "query",
"description": "Filters web timecards to a specific assignment Id.",
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "Startdate",
"in": "query",
"description": "Filter on timecards which contain a date worked after or on the start date.\r\nA date worked is any day between the timecards period start date and period end date.\r\nWhen null, all timecards with a start date prior to the end date are included.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "Enddate",
"in": "query",
"description": "Filter on timecards which contain a date worked prior to or on the end date.\r\nA date worked is any day between the timecards period start date and period end date.\r\nWhen null, all timecards with an end date after the start date are included.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "WebTimecardStatusIds",
"in": "query",
"description": "The webTimecardStatusIds to filter on. If no values are supplied, then all timecard statuses are returned. For valid values reference the WebTimecardStatus Datalist. ref: datalists/webtimecardstatuses",
"style": "form",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
{
"name": "Orderby",
"in": "query",
"description": "Order the results by jobTitle or date. Valid values are 'jobtitle' and 'date'.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "OrderByAscending",
"in": "query",
"description": "Specifies the order by direction. When ordering by jobtitle, the ordering will be done by jobTitle and orderByAscending value, then weekend date descending.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "Skip",
"in": "query",
"description": "The number of items to skip. Used in paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Take",
"in": "query",
"description": "The number of items to take. Used in paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Culture",
"in": "query",
"description": "Optional filter to return the translated texts in the given culture.",
"style": "form",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardsList.WebTimecardSummaryResponse, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardsList.WebTimecardSummaryResponse, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardsList.WebTimecardSummaryResponse, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardsList.WebTimecardSummaryResponse, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardsList.WebTimecardSummaryResponse, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardsList.WebTimecardSummaryResponse, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardsList.WebTimecardSummaryResponse, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Employees"
],
"summary": "Create Web Timecard",
"description": "Creates a Web Timecard for an assignment.\r\nThe fields FullFederalTime, WeeklyHours and DailyHours are to be populated based upon the web timecard template type.\r\nUse the Get Web Timecard Metadata for Assignment endpoint to determine the web timecard template type based upon the selected pay code.\n \n```` Allows roles: ServiceRep, WebUserEmployee ````\n \n```` Requires scope(s): webtimecard-write ````",
"operationId": "EmployeesByIdWebtimecardsPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The details of the web timecard.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateWebTimecardRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateWebTimecardRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateWebTimecardRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateWebTimecardRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateWebTimecardRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateWebTimecardRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateWebTimecardRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateWebTimecardRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.WebTimecards.OrchestrateCreateWebTimecard.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.WebTimecards.OrchestrateCreateWebTimecard.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.WebTimecards.OrchestrateCreateWebTimecard.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.WebTimecards.OrchestrateCreateWebTimecard.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.WebTimecards.OrchestrateCreateWebTimecard.Result"
}
}
}
}
}
}
},
"/Employees/{id}/webtimecards/{webtimecardId}": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Employee Web Timecard Details",
"description": "Returns detailed information about the specified WebTimecard. Includes Adjustments and daily time details.\n \n```` Allows roles: ServiceRep, WebUserEmployee ````\n \n```` Requires scope(s): webtimecard-read or webtimecard-write ````",
"operationId": "EmployeesByIdWebtimecardsByWebtimecardIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "webtimecardId",
"in": "path",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "culture",
"in": "query",
"style": "form",
"schema": {
"maxLength": 20,
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardDetails.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardDetails.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardDetails.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardDetails.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardDetails.Result"
}
}
}
}
}
},
"put": {
"tags": [
"Employees"
],
"summary": "Update Web Timecard",
"description": "Updates web timecard properties.\n \n```` Allows roles: ServiceRep, WebUserEmployee ````\n \n```` Requires scope(s): webtimecard-write ````",
"operationId": "EmployeesByIdWebtimecardsByWebtimecardIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "webtimecardId",
"in": "path",
"description": "The Id of the WebTimecard.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The web timecard properties to update.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.UpdateWebTimecardRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.UpdateWebTimecardRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.UpdateWebTimecardRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.UpdateWebTimecardRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.UpdateWebTimecardRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.UpdateWebTimecardRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.UpdateWebTimecardRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.UpdateWebTimecardRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
},
"delete": {
"tags": [
"Employees"
],
"summary": "Deletes a Web Timecard",
"description": "Deletes a web timecard. Only web timecards with a status of Not Submitted or Rejected can be deleted. ref: datalists/webtimecards/statuses\n \n```` Allows roles: ServiceRep, WebUserEmployee ````\n \n```` Requires scope(s): webtimecard-write ````",
"operationId": "EmployeesByIdWebtimecardsByWebtimecardIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "webtimecardId",
"in": "path",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/webtimecards/{webtimecardId}/adjustments": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Web Timecard Adjustments",
"description": "Returns a list of adjustments for an employee web timecard.\n \n```` Allows roles: ServiceRep, WebUserEmployee ````\n \n```` Requires scope(s): webtimecard-read or webtimecard-write ````",
"operationId": "EmployeesByIdWebtimecardsByWebtimecardIdAdjustmentsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "webTimecardId",
"in": "path",
"description": "The Id of the web timecard.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used in paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to take. Used in paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardAdjustmentsList.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardAdjustmentsList.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardAdjustmentsList.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardAdjustmentsList.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardAdjustmentsList.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardAdjustmentsList.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardAdjustmentsList.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Employees"
],
"summary": "Create Web Timecard Adjustment",
"description": "Creates an adjustment on a web timecard.\n \n```` Allows roles: ServiceRep, WebUserEmployee ````\n \n```` Requires scope(s): webtimecard-write ````",
"operationId": "EmployeesByIdWebtimecardsByWebtimecardIdAdjustmentsPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "webtimecardId",
"in": "path",
"description": "The Id of the web timecard.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The details of the adjustment.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateWebTimecardAdjustmentRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateWebTimecardAdjustmentRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateWebTimecardAdjustmentRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateWebTimecardAdjustmentRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateWebTimecardAdjustmentRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateWebTimecardAdjustmentRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateWebTimecardAdjustmentRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateWebTimecardAdjustmentRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.WebTimecards.CreateWebTimecardAdjustment.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.WebTimecards.CreateWebTimecardAdjustment.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.WebTimecards.CreateWebTimecardAdjustment.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.WebTimecards.CreateWebTimecardAdjustment.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.WebTimecards.CreateWebTimecardAdjustment.Result"
}
}
}
}
}
}
},
"/Employees/{id}/webtimecards/{webtimecardId}/adjustments/{timecardAdjustmentId}": {
"put": {
"tags": [
"Employees"
],
"summary": "Update web Timecard Adjustment",
"description": "Update an adjustment on a web timecard.\n \n```` Allows roles: ServiceRep, WebUserEmployee ````\n \n```` Requires scope(s): webtimecard-write ````",
"operationId": "EmployeesByIdWebtimecardsByWebtimecardIdAdjustmentsByTimecardAdjustmentIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "webtimecardId",
"in": "path",
"description": "The Id of the web timecard.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "timecardAdjustmentId",
"in": "path",
"description": "The Id of the adjustment.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The details of the adjustment.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.UpdateWebTimecardAdjustmentRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.UpdateWebTimecardAdjustmentRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.UpdateWebTimecardAdjustmentRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.UpdateWebTimecardAdjustmentRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.UpdateWebTimecardAdjustmentRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.UpdateWebTimecardAdjustmentRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.UpdateWebTimecardAdjustmentRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.UpdateWebTimecardAdjustmentRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
},
"delete": {
"tags": [
"Employees"
],
"summary": "Delete Web Timecard Adjustment",
"description": "Delete an adjustment on a web timecard.\n \n```` Allows roles: ServiceRep, WebUserEmployee ````\n \n```` Requires scope(s): webtimecard-write ````",
"operationId": "EmployeesByIdWebtimecardsByWebtimecardIdAdjustmentsByTimecardAdjustmentIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "webtimecardId",
"in": "path",
"description": "The Id of the web timecard.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "timecardAdjustmentId",
"in": "path",
"description": "The Id of the adjustment.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/webtimecards/{webtimecardId}/adjustments/{timecardAdjustmentId}/document": {
"post": {
"tags": [
"Employees"
],
"summary": "Create Web Timecard Adjustment Document",
"description": "Adds a document to a web timecard adjustment.\r\nThis requires a multipart form-data POST request.\r\nOne part must contain the file to upload and subsequent parts will be used to provide\r\nother data such as documentTypeId.\r\n \r\nFor more information about using formdata, see: https://developer.mozilla.org/en-US/docs/Web/API/FormData/FormData\r\nFor more information about using multipart/form-data, see: http://stackoverflow.com/questions/4526273/what-does-enctype-multipart-form-data-mean\r\nBelow is an example multipart/form-data POST request body:\r\n \r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn\r\nContent-Disposition: form-data; name=\"file\"; filename=\"Test.txt\"\r\nContent-Type: text/plain\r\n \r\nThis is where the file content is placed!\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn\r\nContent-Disposition: form-data; name=\"fileName\"\r\n \r\nNewFileName.txt\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn\r\nContent-Disposition: form-data; name=\"expirationDate\"\r\n \r\n2012-12-21\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn\r\nContent-Disposition: form-data; name=\"documentTypeId\"\r\n \r\n1\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn\r\nContent-Disposition: form-data; name=\"version\"\r\n \r\n1\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn\r\nContent-Disposition: form-data; name=\"description\"\r\n \r\ntest\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn--\n \n```` Allows roles: ServiceRep, WebUserEmployee, WebUserContact ````\n \n```` Requires scope(s): webtimecard-write ````",
"operationId": "EmployeesByIdWebtimecardsByWebtimecardIdAdjustmentsByTimecardAdjustmentIdDocumentPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "webtimecardId",
"in": "path",
"description": "The Id of the web timecard.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "timecardAdjustmentId",
"in": "path",
"description": "The Id of the adjustment.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.WebTimecards.CreateWebTimecardAdjustmentDocument.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.WebTimecards.CreateWebTimecardAdjustmentDocument.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.WebTimecards.CreateWebTimecardAdjustmentDocument.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.WebTimecards.CreateWebTimecardAdjustmentDocument.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.WebTimecards.CreateWebTimecardAdjustmentDocument.Result"
}
}
}
}
}
},
"delete": {
"tags": [
"Employees"
],
"summary": "Deletes a Web Timecard Adjustment Document",
"description": "Deletes a web timecard adjustment document.\n \n```` Allows roles: ServiceRep, WebUserEmployee, WebUserContact ````\n \n```` Requires scope(s): webtimecard-write ````",
"operationId": "EmployeesByIdWebtimecardsByWebtimecardIdAdjustmentsByTimecardAdjustmentIdDocumentDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "webtimecardId",
"in": "path",
"description": "The Id of the timecard.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "timecardAdjustmentId",
"in": "path",
"description": "The Id of the timecard adjustment.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/webtimecards/{webtimecardId}/documents": {
"get": {
"tags": [
"Employees"
],
"summary": "Gets Web Timecard Documents",
"description": "Returns a list of documents for an employee web timecard\n \n```` Allows roles: ServiceRep, WebUserEmployee ````\n \n```` Requires scope(s): webtimecard-read or webtimecard-write ````",
"operationId": "EmployeesByIdWebtimecardsByWebtimecardIdDocumentsGet",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "webtimecardId",
"in": "path",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardDocumentsList.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardDocumentsList.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardDocumentsList.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardDocumentsList.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardDocumentsList.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardDocumentsList.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardDocumentsList.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Employees/{id}/webtimecards/{webtimecardId}/submit": {
"post": {
"tags": [
"Employees"
],
"summary": "Submits a Web Timecard",
"description": "Submits a web timecard and starts the approval process. Only web timecards with a status of Not Submitted or Rejected can be submitted.\n \n```` Allows roles: ServiceRep, WebUserEmployee ````\n \n```` Requires scope(s): webtimecard-write ````",
"operationId": "EmployeesByIdWebtimecardsByWebtimecardIdSubmitPost",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "webtimecardId",
"in": "path",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/webtimecards/{webtimecardId}/time": {
"put": {
"tags": [
"Employees"
],
"summary": "Update Web Timecard Time Worked",
"description": "Updates daily, daily full federal time, or weekly time on a web timecard based upon the timecard template.\r\nThis endpoint only accepts single days when daily or full federal time templates are used.\n \n```` Allows roles: ServiceRep, WebUserEmployee ````\n \n```` Requires scope(s): webtimecard-write ````",
"operationId": "EmployeesByIdWebtimecardsByWebtimecardIdTimePut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "webtimecardId",
"in": "path",
"description": "The Id of the WebTimecard.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The details of the time.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.UpdateWebTimecardTimeRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.UpdateWebTimecardTimeRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.UpdateWebTimecardTimeRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.UpdateWebTimecardTimeRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.UpdateWebTimecardTimeRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.UpdateWebTimecardTimeRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.UpdateWebTimecardTimeRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.UpdateWebTimecardTimeRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/webtimecards/{webtimecardId}/unlock": {
"post": {
"tags": [
"Employees"
],
"summary": "Unlocks a Web Timecard",
"description": "Unlocks a web timecard. Only web timecards with a status of Submitted, Partially Approved, or Approved can be unlocked. ref: datalists/webtimecards/statuses\n \n```` Allows roles: ServiceRep, WebUserEmployee ````\n \n```` Requires scope(s): webtimecard-write ````",
"operationId": "EmployeesByIdWebtimecardsByWebtimecardIdUnlockPost",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "webtimecardId",
"in": "path",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/webtimecards/{webtimecardId}/updateWebTimecard": {
"put": {
"tags": [
"Employees"
],
"summary": "Update Web Timecard Time Worked (TW Mobile App only)",
"description": "Updates daily, daily full federal time, or weekly time on a web timecard based upon the timecard template.\r\nThis endpoint accepts multiple days when daily templates are used.\n \n```` Allows roles: ServiceRep, WebUserEmployee ````\n \n```` Requires scope(s): webtimecard-write ````",
"operationId": "EmployeesByIdWebtimecardsByWebtimecardIdUpdateWebTimecardPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "webtimecardId",
"in": "path",
"description": "The Id of the WebTimecard.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The details of the time.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.UpdateWebTimecardTimeRequestMobile"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.UpdateWebTimecardTimeRequestMobile"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.UpdateWebTimecardTimeRequestMobile"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.UpdateWebTimecardTimeRequestMobile"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.UpdateWebTimecardTimeRequestMobile"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.UpdateWebTimecardTimeRequestMobile"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.UpdateWebTimecardTimeRequestMobile"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.UpdateWebTimecardTimeRequestMobile"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/webUser": {
"post": {
"tags": [
"Employees"
],
"summary": "Create Web User Account",
"description": "Creates a web user account for the employee.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write and webuser-write ````",
"operationId": "EmployeesByIdWebUserPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The request body containing information about the new web user.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeWebUserRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeWebUserRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeWebUserRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeWebUserRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeWebUserRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeWebUserRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeWebUserRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeWebUserRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.CreateWebUserAccount.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.CreateWebUserAccount.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.CreateWebUserAccount.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.CreateWebUserAccount.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.CreateWebUserAccount.Result"
}
}
}
}
}
},
"get": {
"tags": [
"Employees"
],
"summary": "Get Web User Account Details",
"description": "Gets details about the Employee's Web User Account if one exists. Returns a NoContent if no such account exists.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdWebUserGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.WebUserAccountDetailsByEntity.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.WebUserAccountDetailsByEntity.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.WebUserAccountDetailsByEntity.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.WebUserAccountDetailsByEntity.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.WebUserAccountDetailsByEntity.Result"
}
}
}
}
}
}
},
"/Employees/{id}/webUser/activate": {
"put": {
"tags": [
"Employees"
],
"summary": "Activate Employee Web User",
"description": "Activates the employee's existing Web User Account.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write and webuser-write ````",
"operationId": "EmployeesByIdWebUserActivatePut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/webUser/availableProductInstances": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Web User Account Available Product Instances List",
"description": "Gets a list of Product Instances not yet associated with the Employee's Web User Account.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdWebUserAvailableProductInstancesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of assignments to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of assignments to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "productId",
"in": "query",
"description": "Optional Id of the product to filter the list.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.WebUserAvailableProductInstances.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.WebUserAvailableProductInstances.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.WebUserAvailableProductInstances.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.WebUserAvailableProductInstances.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.WebUserAvailableProductInstances.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.WebUserAvailableProductInstances.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.WebUserAvailableProductInstances.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Employees/{id}/webUser/companion": {
"post": {
"tags": [
"Employees"
],
"summary": "Link To Companion",
"description": "Links the employee to Companion.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): webuser-write ````",
"operationId": "EmployeesByIdWebUserCompanionPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "A model containing the new Companion instance.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToCompanionRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToCompanionRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToCompanionRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToCompanionRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToCompanionRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToCompanionRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToCompanionRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToCompanionRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
},
"delete": {
"tags": [
"Employees"
],
"summary": "Delete Link To Companion",
"description": "Removes the link between the employee and Companion.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): webuser-write ````",
"operationId": "EmployeesByIdWebUserCompanionDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/webUser/companion/inviteCode": {
"get": {
"tags": [
"Employees"
],
"summary": "Generate Companion Invite Code",
"description": "Generates an invite code for the employee to use to link their Tempworks phone app to their account.\n \n```` Allows roles: Service, ServiceRep, WebUserEmployee ````\n \n```` Requires scope(s): webuser-write ````",
"operationId": "EmployeesByIdWebUserCompanionInviteCodeGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Invite.GenerateInviteCode.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Invite.GenerateInviteCode.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Invite.GenerateInviteCode.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Invite.GenerateInviteCode.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Invite.GenerateInviteCode.Result"
}
}
}
}
}
}
},
"/Employees/{id}/webUser/createInviteLink": {
"post": {
"tags": [
"Employees"
],
"summary": "Creates an invite link for registering a new web user account associated with the specified employee.",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write and webuser-write ````",
"operationId": "EmployeesByIdWebUserCreateInviteLinkPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The unique identifier of the employee for whom the invite link is to be created.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "Request body",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateInviteLinkRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateInviteLinkRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateInviteLinkRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateInviteLinkRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateInviteLinkRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateInviteLinkRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateInviteLinkRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateInviteLinkRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.CreateWebUserAccountRegistrationLink.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.CreateWebUserAccountRegistrationLink.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.CreateWebUserAccountRegistrationLink.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.CreateWebUserAccountRegistrationLink.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.CreateWebUserAccountRegistrationLink.Result"
}
}
}
}
}
}
},
"/Employees/{id}/webUser/deactivate": {
"put": {
"tags": [
"Employees"
],
"summary": "Deactivate Employee Web User",
"description": "Deactivates the employee's existing Web User Account.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write and webuser-write ````",
"operationId": "EmployeesByIdWebUserDeactivatePut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/webUser/documents": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Employees WebUser documents",
"description": "Get a list of documents linked to the specified employee.\n \n```` Allows roles: ServiceRep, WebUserEmployee ````\n \n```` Requires scope(s): Reserved For TempWorks' Products Only ````",
"operationId": "EmployeesByIdWebUserDocumentsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of documents to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of documents to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "sortByAscending",
"in": "query",
"description": "true to sort by ASC, defaults to DESC",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "sortBy",
"in": "query",
"description": "Field to sort by, valid fields are \"DocumentType\" and \"DocumentDate\"",
"style": "form",
"schema": {
"type": "string",
"default": "DocumentDate"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.GetWebUserDocuments.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.GetWebUserDocuments.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.GetWebUserDocuments.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.GetWebUserDocuments.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.GetWebUserDocuments.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.GetWebUserDocuments.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.GetWebUserDocuments.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Employees/{id}/webUser/documents/{documentId}/bytes": {
"get": {
"tags": [
"Employees"
],
"summary": "Download Document by GUID",
"description": "Gets the specified Document for the specified Employee.\n \n```` Allows roles: ServiceRep, WebUserEmployee ````\n \n```` Requires scope(s): Reserved For TempWorks' Products Only ````",
"operationId": "EmployeesByIdWebUserDocumentsByDocumentIdBytesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "documentId",
"in": "path",
"description": "The Id of the document.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "string",
"format": "byte"
}
},
"text/csv": {
"schema": {
"type": "string",
"format": "byte"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"type": "string",
"format": "byte"
}
},
"application/json": {
"schema": {
"type": "string",
"format": "byte"
}
},
"text/json": {
"schema": {
"type": "string",
"format": "byte"
}
},
"application/xml": {
"schema": {
"type": "string",
"format": "byte"
}
},
"text/xml": {
"schema": {
"type": "string",
"format": "byte"
}
}
}
}
}
}
},
"/Employees/{id}/webUser/documentTypes": {
"get": {
"tags": [
"Employees"
],
"summary": "Get a list of Employee Document Types",
"description": "Get a list of paged employee document types\n \n```` Allows roles: ServiceRep, WebUserEmployee ````\n \n```` Requires scope(s): Reserved For TempWorks' Products Only ````",
"operationId": "EmployeesByIdWebUserDocumentTypesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Employee Id",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.GetWebUserDocumentTypes.Result"
}
}
},
"text/csv": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.GetWebUserDocumentTypes.Result"
}
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.GetWebUserDocumentTypes.Result"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.GetWebUserDocumentTypes.Result"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.GetWebUserDocumentTypes.Result"
}
}
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.GetWebUserDocumentTypes.Result"
}
}
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.GetWebUserDocumentTypes.Result"
}
}
}
}
},
"404": {
"description": "Entity not found"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/Employees/{id}/webUser/hrCenter": {
"post": {
"tags": [
"Employees"
],
"summary": "Link To HRCenter",
"description": "Links the employee to HRCenter.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): webuser-write ````",
"operationId": "EmployeesByIdWebUserHrCenterPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "A model containing the new HRCenter instance",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToHrCenterRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToHrCenterRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToHrCenterRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToHrCenterRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToHrCenterRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToHrCenterRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToHrCenterRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToHrCenterRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
},
"delete": {
"tags": [
"Employees"
],
"summary": "Delete Link To HRCenter",
"description": "Removes the link between the employee and HRCenter. Note that this will not delete any data in HRCenter or entered via HRCenter.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): webuser-write ````",
"operationId": "EmployeesByIdWebUserHrCenterDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/webUser/inviteWebUser": {
"post": {
"tags": [
"Employees"
],
"summary": "Invite Employee Web User",
"description": "Invites the employee to register as web user and assigns them a role.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): webuser-write ````",
"operationId": "EmployeesByIdWebUserInviteWebUserPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "A model containing the email and role for the invite.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeInviteWebUserRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeInviteWebUserRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeInviteWebUserRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeInviteWebUserRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeInviteWebUserRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeInviteWebUserRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeInviteWebUserRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeInviteWebUserRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/webUser/jobBoard": {
"post": {
"tags": [
"Employees"
],
"summary": "Link To Job Board",
"description": "Links the employee to the Job Board.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): webuser-write ````",
"operationId": "EmployeesByIdWebUserJobBoardPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "A model containing the new Job Board instance.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToJobBoardRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToJobBoardRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToJobBoardRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToJobBoardRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToJobBoardRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToJobBoardRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToJobBoardRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToJobBoardRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
},
"delete": {
"tags": [
"Employees"
],
"summary": "Delete Link To Job Board",
"description": "Removes the link between the employee and the Job Board.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): webuser-write ````",
"operationId": "EmployeesByIdWebUserJobBoardDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/webUser/LogWebUserPasswordResetEmail": {
"put": {
"tags": [
"Employees"
],
"summary": "Log when a password reset email is sent to an employee",
"description": "\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): webuser-write ````",
"operationId": "EmployeesByIdWebUserLogWebUserPasswordResetEmailPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "Body of the request containing information about the WebUser account and the entity who\r\nrequested the password reset email.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.WebUserPasswordResetEmailRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.WebUserPasswordResetEmailRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.WebUserPasswordResetEmailRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.WebUserPasswordResetEmailRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.WebUserPasswordResetEmailRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.WebUserPasswordResetEmailRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.WebUserPasswordResetEmailRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.WebUserPasswordResetEmailRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/webUser/openAPICustomIntegration": {
"post": {
"tags": [
"Employees"
],
"summary": "Link to an OpenAPICustomIntegration",
"description": "Links the employee to an Open API Custom Integration.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): webuser-write ````",
"operationId": "EmployeesByIdWebUserOpenAPICustomIntegrationPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "A model containing the Open API Custom Integration instance to link",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToOpenAPICustomIntegrationRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToOpenAPICustomIntegrationRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToOpenAPICustomIntegrationRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToOpenAPICustomIntegrationRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToOpenAPICustomIntegrationRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToOpenAPICustomIntegrationRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToOpenAPICustomIntegrationRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToOpenAPICustomIntegrationRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
},
"delete": {
"tags": [
"Employees"
],
"summary": "Delete link to OpenAPICustomIntegration",
"description": "Removes the link between the employee and the Open API Custom Integration.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): webuser-write ````",
"operationId": "EmployeesByIdWebUserOpenAPICustomIntegrationDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "openAPICustomIntegrationProductInstanceId",
"in": "query",
"description": "The id of Open API Custom Integration instance to unlink",
"required": true,
"style": "form",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/webUser/productInstances": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Web User Account Product Instances List",
"description": "Gets a list of Product Instances associated with the Employee's Web User Account.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdWebUserProductInstancesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of assignments to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of assignments to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.WebUserAccountProductInstanceListByOriginPairQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.WebUserAccountProductInstanceListByOriginPairQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.WebUserAccountProductInstanceListByOriginPairQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.WebUserAccountProductInstanceListByOriginPairQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.WebUserAccountProductInstanceListByOriginPairQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.WebUserAccountProductInstanceListByOriginPairQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.WebUserAccountProductInstanceListByOriginPairQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Employees/{id}/webUser/rename": {
"put": {
"tags": [
"Employees"
],
"summary": "Rename Employee Web User",
"description": "Renames the employee's Web User Account.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): webuser-write ````",
"operationId": "EmployeesByIdWebUserRenamePut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "A model containing the new username",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.RenameWebUserRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.RenameWebUserRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.RenameWebUserRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.RenameWebUserRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.RenameWebUserRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.RenameWebUserRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.RenameWebUserRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.RenameWebUserRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/webUser/resetPassword": {
"put": {
"tags": [
"Employees"
],
"summary": "Reset Employee Web User Password",
"description": "Resets the password of the employee requiring the user to change their password at next login.\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): webuser-write ````",
"operationId": "EmployeesByIdWebUserResetPasswordPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "A model containing the new temporary password",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.ResetWebUserPasswordRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.ResetWebUserPasswordRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.ResetWebUserPasswordRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.ResetWebUserPasswordRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.ResetWebUserPasswordRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.ResetWebUserPasswordRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.ResetWebUserPasswordRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.ResetWebUserPasswordRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/webUser/tempWorksMobileApp": {
"post": {
"tags": [
"Employees"
],
"summary": "Link To TempWorks Mobile App",
"description": "Links the employee to the TempWorks Mobile App.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): webuser-write ````",
"operationId": "EmployeesByIdWebUserTempWorksMobileAppPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "A model containing the new TempWorks Mobile App instance.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToTempWorksMobileAppRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToTempWorksMobileAppRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToTempWorksMobileAppRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToTempWorksMobileAppRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToTempWorksMobileAppRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToTempWorksMobileAppRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToTempWorksMobileAppRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToTempWorksMobileAppRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
},
"delete": {
"tags": [
"Employees"
],
"summary": "Delete Link To TempWorks Mobile App",
"description": "Removes the link between the employee and the TempWorks Mobile App.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): webuser-write ````",
"operationId": "EmployeesByIdWebUserTempWorksMobileAppDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/webUser/unlock": {
"put": {
"tags": [
"Employees"
],
"summary": "Unlocks Employee Web User.",
"description": "Unlocks the Employee web user. \r\nLocking occurs when a user had multiple unsuccessful login attempts and in result,\r\nfurther login attempts are disabled.\r\nWhen unlocked, a web user is enabled to perform login attempts again.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): webuser-write ````",
"operationId": "EmployeesByIdWebUserUnlockPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/webUser/UpdatePassword": {
"put": {
"tags": [
"Employees"
],
"summary": "Update Employee Web User Password",
"description": "Allows the Employee to update their password using the old password as verification.\n \n```` Allows roles: WebUserEmployee ````\n \n```` Requires scope(s): webuser-write ````",
"operationId": "EmployeesByIdWebUserUpdatePasswordPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "A model containing the old and new password.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.UpdateWebUserPasswordRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.UpdateWebUserPasswordRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.UpdateWebUserPasswordRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.UpdateWebUserPasswordRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.UpdateWebUserPasswordRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.UpdateWebUserPasswordRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.UpdateWebUserPasswordRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.UpdateWebUserPasswordRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/webUser/uploadedDocuments": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Employees WebUser uploaded documents and resumes",
"description": "Get a list of documents the specified employee has uploaded.\n \n```` Allows roles: ServiceRep, WebUserEmployee ````\n \n```` Requires scope(s): Reserved For TempWorks' Products Only ````",
"operationId": "EmployeesByIdWebUserUploadedDocumentsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.GetWebUserUploadedDocuments.Result"
}
}
},
"text/csv": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.GetWebUserUploadedDocuments.Result"
}
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.GetWebUserUploadedDocuments.Result"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.GetWebUserUploadedDocuments.Result"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.GetWebUserUploadedDocuments.Result"
}
}
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.GetWebUserUploadedDocuments.Result"
}
}
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.GetWebUserUploadedDocuments.Result"
}
}
}
}
}
}
}
},
"/Employees/{id}/webUser/webCenter": {
"post": {
"tags": [
"Employees"
],
"summary": "Link To Web Center",
"description": "Links the employee to Web Center and assigns them a role.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): webuser-write ````",
"operationId": "EmployeesByIdWebUserWebCenterPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "A model containing the new Web Center instance and role",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToWebCenterRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToWebCenterRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToWebCenterRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToWebCenterRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToWebCenterRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToWebCenterRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToWebCenterRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.LinkToWebCenterRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
},
"delete": {
"tags": [
"Employees"
],
"summary": "Delete Link To Web Center",
"description": "Removes the link between the employee and Web Center.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): webuser-write ````",
"operationId": "EmployeesByIdWebUserWebCenterDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/webUser/webCenter/availableRoles": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Available Web Center Role List",
"description": "Gets a list of Web Center roles available to the employee.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): webuser-read or webuser-write ````",
"operationId": "EmployeesByIdWebUserWebCenterAvailableRolesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "webCenterProductInstanceId",
"in": "query",
"description": "The Product Instance Id of the Web Center Instance",
"required": true,
"style": "form",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.WebCenterRoleList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.WebCenterRoleList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.WebCenterRoleList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.WebCenterRoleList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.WebCenterRoleList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.WebCenterRoleList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.WebCenterRoleList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Employees/{id}/webUser/webCenter/role": {
"put": {
"tags": [
"Employees"
],
"summary": "Change Web Center Role",
"description": "Changes the employee's Web Center role.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): webuser-write ````",
"operationId": "EmployeesByIdWebUserWebCenterRolePut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "A model containing the new role",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.ChangeWebCenterRoleRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.ChangeWebCenterRoleRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.ChangeWebCenterRoleRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.ChangeWebCenterRoleRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.ChangeWebCenterRoleRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.ChangeWebCenterRoleRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.ChangeWebCenterRoleRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.ChangeWebCenterRoleRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/WorkHistory": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Work History list",
"description": "Gets a list of work history items for the specified employee. The work history items are ordered from newest to the oldest.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdWorkHistoryGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "startDate",
"in": "query",
"description": "Optional parameter to filter the list on jobs that have started after to the supplied date. If not set all jobs with a start date after January 1st, 1900 are returned.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "endDate",
"in": "query",
"description": "Optional parameter to filter the list on jobs that have started prior to the supplied date. If not set all jobs with a start date prior to June 6th, 2079 are returned.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.WorkHistory.EmployeeWorkHistoriesQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.WorkHistory.EmployeeWorkHistoriesQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.WorkHistory.EmployeeWorkHistoriesQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.WorkHistory.EmployeeWorkHistoriesQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.WorkHistory.EmployeeWorkHistoriesQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.WorkHistory.EmployeeWorkHistoriesQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.WorkHistory.EmployeeWorkHistoriesQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Employees"
],
"summary": "Create Work History",
"description": "Creates a work history item for the specified employee.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdWorkHistoryPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The request body containing the new values for the work history.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeWorkHistoryRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeWorkHistoryRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeWorkHistoryRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeWorkHistoryRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeWorkHistoryRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeWorkHistoryRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeWorkHistoryRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeWorkHistoryRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.WorkHistory.CreateEmployeeWorkHistoryCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.WorkHistory.CreateEmployeeWorkHistoryCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.WorkHistory.CreateEmployeeWorkHistoryCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.WorkHistory.CreateEmployeeWorkHistoryCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.WorkHistory.CreateEmployeeWorkHistoryCommand.Result"
}
}
}
}
}
}
},
"/Employees/{id}/WorkHistory/{workHistoryId}": {
"get": {
"tags": [
"Employees"
],
"summary": "Get Work History",
"description": "Gets a work history item for the specified employee.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdWorkHistoryByWorkHistoryIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "workHistoryId",
"in": "path",
"description": "The Id of the work history",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.WorkHistory.EmployeeWorkHistoriesQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.WorkHistory.EmployeeWorkHistoriesQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.WorkHistory.EmployeeWorkHistoriesQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.WorkHistory.EmployeeWorkHistoriesQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.WorkHistory.EmployeeWorkHistoriesQuery.Result"
}
}
}
}
}
},
"delete": {
"tags": [
"Employees"
],
"summary": "Delete Work History",
"description": "Deletes a work history item for the specified employee.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdWorkHistoryByWorkHistoryIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "workHistoryId",
"in": "path",
"description": "The Id of the work history",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
},
"put": {
"tags": [
"Employees"
],
"summary": "Update Work History",
"description": "Updates a work history item for the specified employee.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdWorkHistoryByWorkHistoryIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "workHistoryId",
"in": "path",
"description": "The Id of the work history",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The request body containing the new values for the work history.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeWorkHistoryRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeWorkHistoryRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeWorkHistoryRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeWorkHistoryRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeWorkHistoryRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeWorkHistoryRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeWorkHistoryRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeWorkHistoryRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/{id}/workInterests": {
"get": {
"tags": [
"Employees"
],
"summary": "Get employee work interests.",
"description": "Gets work interests about the specified employee if they exist.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesByIdWorkInterestsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.WorkInterests.EmployeeWorkInterests.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.WorkInterests.EmployeeWorkInterests.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.WorkInterests.EmployeeWorkInterests.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.WorkInterests.EmployeeWorkInterests.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.WorkInterests.EmployeeWorkInterests.Result"
}
}
}
}
}
},
"put": {
"tags": [
"Employees"
],
"summary": "Update Employee Work Interests.",
"description": "Update work interests for the specified employee if they exist.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesByIdWorkInterestsPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The request body containing the new values for the employee's work interests.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeWorkInterestsRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeWorkInterestsRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeWorkInterestsRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeWorkInterestsRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeWorkInterestsRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeWorkInterestsRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeWorkInterestsRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeWorkInterestsRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/AssessmentSessions": {
"get": {
"tags": [
"Employees"
],
"summary": "Get All Assessment Sessions",
"description": "Gets a list of all assessment sessions assigned to employees. You can use various optional filters to narrow your search.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "EmployeesAssessmentSessionsGet",
"parameters": [
{
"name": "assessmentVendorId",
"in": "query",
"description": "Optional filter on the assessment vendor.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "vendorSessionId",
"in": "query",
"description": "Optional filter on the vendor supplied sessionId.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "assessmentSessionId",
"in": "query",
"description": "Optional filter on the unique identifier of the assessment session.",
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "lastName",
"in": "query",
"description": "Optional filter on employee last name.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "firstName",
"in": "query",
"description": "Optional filter on employee first name.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "branchId",
"in": "query",
"description": "Optional filter on employee branch. Valid branches can be found in the Branch datalist.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "isComplete",
"in": "query",
"description": "Optional filter on the complete status of the assessment session.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "isActive",
"in": "query",
"description": "Optional filter on the active status of the assessment session. Sessions that are canceled or expired will be inactive.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of assessment sessions to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of assessment sessions to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.AssessmentSessionsQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.AssessmentSessionsQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.AssessmentSessionsQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.AssessmentSessionsQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.AssessmentSessionsQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.AssessmentSessionsQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.AssessmentSessionsQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Employees/AssessmentSessions/FormFields/Validate": {
"post": {
"tags": [
"Employees"
],
"summary": "Validate Session Request Form Fields",
"description": "Validates the form fields which will act as overrides during the session request. \r\nA HTTP 204 response denotes success. Any validation errors will be returned on HTTP 400\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "EmployeesAssessmentSessionsFormFieldsValidatePost",
"requestBody": {
"description": "The fields to validate",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.AssessmentSessionFormFields"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.AssessmentSessionFormFields"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.AssessmentSessionFormFields"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.AssessmentSessionFormFields"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.AssessmentSessionFormFields"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.AssessmentSessionFormFields"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.AssessmentSessionFormFields"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.AssessmentSessionFormFields"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Employees/governmentPersonalIdentifier/duplicates": {
"post": {
"tags": [
"Employees"
],
"summary": "Get a list of employees with the same government personal identifier.\r\nThis endpoint is partially implemented. It currently only returns matching employees whose SSN has been scrubbed to just the last 4 digits, and who have a matching LastName.",
"description": "\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesGovernmentPersonalIdentifierDuplicatesPost",
"requestBody": {
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.GetDuplicateGovernmentPersonalIdsRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.GetDuplicateGovernmentPersonalIdsRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.GetDuplicateGovernmentPersonalIdsRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.GetDuplicateGovernmentPersonalIdsRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.GetDuplicateGovernmentPersonalIdsRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.GetDuplicateGovernmentPersonalIdsRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.GetDuplicateGovernmentPersonalIdsRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.GetDuplicateGovernmentPersonalIdsRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeGovernmentPersonalIdDuplicates.Result"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeGovernmentPersonalIdDuplicates.Result"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeGovernmentPersonalIdDuplicates.Result"
}
}
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeGovernmentPersonalIdDuplicates.Result"
}
}
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeGovernmentPersonalIdDuplicates.Result"
}
}
}
}
}
}
}
},
"/Employees/onboarding/register": {
"post": {
"tags": [
"Employees"
],
"summary": "Creates an employee profile and webuser account for an applicant.",
"description": "\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesOnboardingRegisterPost",
"requestBody": {
"description": "",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.RegisterApplicantRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.RegisterApplicantRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.RegisterApplicantRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.RegisterApplicantRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.RegisterApplicantRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.RegisterApplicantRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.RegisterApplicantRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.RegisterApplicantRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.RegisterNewApplicantCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.RegisterNewApplicantCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.RegisterNewApplicantCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.RegisterNewApplicantCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.RegisterNewApplicantCommand.Result"
}
}
}
}
}
}
},
"/Employees/Resume": {
"post": {
"tags": [
"Employees"
],
"summary": "Create Employee From Resume",
"description": "Parses the supplied resume into an employee.\r\n \r\nAccepted request header values:\r\nHowHeardOfId - A valid value from /DataLists/howheardof\r\nFirstName - Override the first name parsed from the resume\r\nLastName - Override the last name parsed from the resume\r\nUseStandardizedAddressIfExists - If true and an address comes back from the standardization service, that address will be used in place of the one provided.\r\nBranchId - An optional override BranchID to create the employee record in.\r\nIf false, whatever address is parsed will be used. If set to false and address validation is required, then most resumes parses will most likely fail.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "EmployeesResumePost",
"responses": {
"201": {
"description": "A model containing the Ids of the new employee resources",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.OrchestrateCreateEmployeeCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.OrchestrateCreateEmployeeCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.OrchestrateCreateEmployeeCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.OrchestrateCreateEmployeeCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.OrchestrateCreateEmployeeCommand.Result"
}
}
}
},
"521": {
"description": "The resume parsing service is encountering server issues. Try again later."
}
}
}
},
"/Employees/Validate": {
"put": {
"tags": [
"Employees"
],
"summary": "Validates the list of properties from the client",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesValidatePut",
"requestBody": {
"description": "The request body containing the properties to be validated",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeCreateValidationRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeCreateValidationRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeCreateValidationRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeCreateValidationRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeCreateValidationRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeCreateValidationRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeCreateValidationRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeCreateValidationRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/Employees/validate/governmentPersonalIdentifierAndLastName": {
"put": {
"tags": [
"Employees"
],
"summary": "Validates if an employee already exists under this product instance that shares the combination of last four digits of their personal goverment identifier and last name.",
"description": "\n \n```` Allows roles: WebUserEmployee, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "EmployeesValidateGovernmentPersonalIdentifierAndLastNamePut",
"requestBody": {
"description": "The request for duplicate employee by last four government id characters and last name combination.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeLastFourCharsGovIdAndLastNameDuplicateRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeLastFourCharsGovIdAndLastNameDuplicateRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeLastFourCharsGovIdAndLastNameDuplicateRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeLastFourCharsGovIdAndLastNameDuplicateRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeLastFourCharsGovIdAndLastNameDuplicateRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeLastFourCharsGovIdAndLastNameDuplicateRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeLastFourCharsGovIdAndLastNameDuplicateRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeLastFourCharsGovIdAndLastNameDuplicateRequest"
}
}
}
},
"responses": {
"200": {
"description": ""
}
}
}
},
"/Employees/webUser/validate": {
"post": {
"tags": [
"Employees"
],
"summary": "Validate Employee Web User Credentials. Returns EmployeeID if the passed in username and password are valid",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): webuser-write ````",
"operationId": "EmployeesWebUserValidatePost",
"requestBody": {
"description": "Body of the request will contain the user provided username and password to be validated.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.WebUserValidateCredentialsRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.WebUserValidateCredentialsRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.WebUserValidateCredentialsRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.WebUserValidateCredentialsRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.WebUserValidateCredentialsRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.WebUserValidateCredentialsRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.WebUserValidateCredentialsRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.WebUserValidateCredentialsRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Queries.GetEmployeeIdForEmployeeWebUserQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Queries.GetEmployeeIdForEmployeeWebUserQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Queries.GetEmployeeIdForEmployeeWebUserQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Queries.GetEmployeeIdForEmployeeWebUserQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Queries.GetEmployeeIdForEmployeeWebUserQuery.Result"
}
}
}
}
}
}
},
"/Employers/{employerId}": {
"get": {
"tags": [
"Employers"
],
"summary": "Gets the details of a specific employer.",
"description": "\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): employer-read or employer-write ````",
"operationId": "EmployersByEmployerIdGet",
"parameters": [
{
"name": "employerId",
"in": "path",
"description": "The unique identifier of the employer.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employers.Service.Commands.GetEmployerDetails.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employers.Service.Commands.GetEmployerDetails.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employers.Service.Commands.GetEmployerDetails.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employers.Service.Commands.GetEmployerDetails.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employers.Service.Commands.GetEmployerDetails.Result"
}
}
}
}
}
}
},
"/Everify/Cases/AlertCounts": {
"get": {
"tags": [
"Everify"
],
"summary": "Get Alert Counts for all E-Verify cases.",
"description": "The number of cases to be closed, cases with new updates, and case with work documents about to expire.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): everify-read or everify-write ````",
"operationId": "EverifyCasesAlertCountsGet",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Commands.AlertCountsQuery.Response"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Commands.AlertCountsQuery.Response"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Commands.AlertCountsQuery.Response"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Commands.AlertCountsQuery.Response"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Commands.AlertCountsQuery.Response"
}
}
}
}
}
}
},
"/Everify/Cases/Search": {
"get": {
"tags": [
"Everify"
],
"summary": "Search for E-Verify cases",
"description": "Returns a collection of E-Verify cases filtered by the criteria specified.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): everify-read or everify-write ````",
"operationId": "EverifyCasesSearchGet",
"parameters": [
{
"name": "SearchText",
"in": "query",
"description": "example: John\r\nThe search text to search cases by.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "SearchField",
"in": "query",
"description": "example: ssn\r\nThe field to search on. (See serch_field_enum for options)",
"style": "form",
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Enums.SearchFieldEnum"
}
},
{
"name": "OrderBy",
"in": "query",
"description": "default: case_number\r\nexample: last_name\r\nThe field to sort results by. (See sort_field_enum for options)",
"style": "form",
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Enums.SortFieldEnum"
}
},
{
"name": "OrderByAscending",
"in": "query",
"description": "default: true\r\nThe direction to sort results by. (see sort_direction_enum for options)",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "Skip",
"in": "query",
"description": "The number of items to skip. Used in paging.\r\nDue to E-Verify paging logic, Skip must be a multiple of Take ( Skip % Take = 0 ) and Skip must be greater than Take except when skip is 0.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Take",
"in": "query",
"description": "The number of items to take.\r\nDue to E-Verify paging logic, Skip % Take must = 0 and Take must be less than Skip except when skip is 0.",
"style": "form",
"schema": {
"maximum": 120,
"minimum": 1,
"type": "integer",
"format": "int32"
}
},
{
"name": "DateFrom",
"in": "query",
"description": "example: 01/01/2015\r\nThe earliest updated at date from which to return cases.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "DateTo",
"in": "query",
"description": "example: 01/01/2018\r\nThe latest updated at date from which to return cases.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "Filter",
"in": "query",
"description": "The status of cases to filter by. (OpenCases, CaseWithNewUpdates, CasesInProgress, WorkDocsExpiring, CasesToBeClosed, ClosedCases, RecentlyAutoClosed, DraftCases)",
"style": "form",
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Enums.FilterEnum"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.CasesSearchResultItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.CasesSearchResultItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.CasesSearchResultItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.CasesSearchResultItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.CasesSearchResultItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.CasesSearchResultItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.CasesSearchResultItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Everify/Cases/Updated": {
"post": {
"tags": [
"Everify"
],
"summary": "Process Case Updates.",
"description": "This call will retrieve all case updates, update the database with these updates, and confirm the updates.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): everify-read or everify-write ````",
"operationId": "EverifyCasesUpdatedPost",
"requestBody": {
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.UpdatedRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.UpdatedRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.UpdatedRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.UpdatedRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.UpdatedRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.UpdatedRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.UpdatedRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.UpdatedRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.MultiCaseWorkflowResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.MultiCaseWorkflowResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.MultiCaseWorkflowResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.MultiCaseWorkflowResponse"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.MultiCaseWorkflowResponse"
}
}
}
}
}
}
},
"/Everify/DataLists/AlertTypes": {
"get": {
"tags": [
"Everify"
],
"summary": "Get Alert Types",
"description": "V30 only.\r\nReturns a list of E-Verify Alert Types for fetching alert counts.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): everify-read or everify-write ````",
"operationId": "EverifyDataListsAlertTypesGet",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Everify/DataLists/CaseClosureReasons": {
"get": {
"tags": [
"Everify"
],
"summary": "Get Case Closure Reasons",
"description": "V30 only.\r\nReturns a list of E-Verify Closure Reasons for a case.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): everify-read or everify-write ````",
"operationId": "EverifyDataListsCaseClosureReasonsGet",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Everify/DataLists/CitizenshipStatuses": {
"get": {
"tags": [
"Everify"
],
"summary": "Get Citizenship Statuses",
"description": "V30 only.\r\nReturns a list of E-Verify Citizenship Statuses ordered by the Description.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): everify-read or everify-write ````",
"operationId": "EverifyDataListsCitizenshipStatusesGet",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Everify/DataLists/Countries": {
"get": {
"tags": [
"Everify"
],
"summary": "Get a list of Countries for foreign passports.",
"description": "V30 only.\r\nReturns a list of E-Verify Countries ordered by the Description.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): everify-read or everify-write ````",
"operationId": "EverifyDataListsCountriesGet",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Everify/DataLists/DocumentCategories": {
"get": {
"tags": [
"Everify"
],
"summary": "Get Document Categories.",
"description": "V30 only.\r\nReturns a list of E-Verify Document Categories.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): everify-read or everify-write ````",
"operationId": "EverifyDataListsDocumentCategoriesGet",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Everify/DataLists/DocumentSubTypes": {
"get": {
"tags": [
"Everify"
],
"summary": "Get Document Sub Types for a specific document type.",
"description": "V30 only.\r\nReturns a list of E-Verify Document sub Types based upon the supplied Document Type.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): everify-read or everify-write ````",
"operationId": "EverifyDataListsDocumentSubTypesGet",
"parameters": [
{
"name": "documentType",
"in": "query",
"description": "The document type code to retrieve sub types for.",
"style": "form",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Everify/DataLists/DocumentTypes": {
"get": {
"tags": [
"Everify"
],
"summary": "Get Document Types for a specific citizenship code and document type category.",
"description": "V30 only.\r\nReturns a list of E-Verify Document Types based upon the supplied Citizenship Status Code and Document Category.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): everify-read or everify-write ````",
"operationId": "EverifyDataListsDocumentTypesGet",
"parameters": [
{
"name": "citizenshipStatusCode",
"in": "query",
"description": "Filter using the Citizenship Status Code. Valid values are listed in the E-Verify Citizenship Statuses datalist.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "documentCategory",
"in": "query",
"description": "Filter using DocumentCategory Code.",
"style": "form",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Everify/DataLists/Languages": {
"get": {
"tags": [
"Everify"
],
"summary": "Get Languages",
"description": "V30 only.\r\nReturns a list of E-Verify Languages to print for printing notices.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): everify-read or everify-write ````",
"operationId": "EverifyDataListsLanguagesGet",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Everify/DataLists/ReasonsForDelay": {
"get": {
"tags": [
"Everify"
],
"summary": "Get Reasons For Delay",
"description": "V30 only.\r\nReturns a list of E-Verify Reasons For Delay.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): everify-read or everify-write ````",
"operationId": "EverifyDataListsReasonsForDelayGet",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Everify/DataLists/States": {
"get": {
"tags": [
"Everify"
],
"summary": "Get States. V30 only.",
"description": "V30 only.\r\nReturns a list of E-Verify States ordered by the Name.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): everify-read or everify-write ````",
"operationId": "EverifyDataListsStatesGet",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Everify/Health": {
"get": {
"tags": [
"Everify"
],
"summary": "Check Health",
"description": "A Quick check of the API to see if it is available or not.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): everify-read or everify-write ````",
"operationId": "EverifyHealthGet",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
},
"application/xml": {
"schema": {
"type": "boolean"
}
},
"text/xml": {
"schema": {
"type": "boolean"
}
}
}
}
}
}
},
"/Everify/Status": {
"get": {
"tags": [
"Everify"
],
"summary": "Check Health",
"description": "V30 only.\r\nA Quick check of the API to see if it is available or not and if the credentials are missing.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): everify-read or everify-write ````",
"operationId": "EverifyStatusGet",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Commands.StatusQuery.Response"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Commands.StatusQuery.Response"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Commands.StatusQuery.Response"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Commands.StatusQuery.Response"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Commands.StatusQuery.Response"
}
}
}
}
}
}
},
"/Everify/VerifyCredentials": {
"get": {
"tags": [
"Everify"
],
"summary": "Verify E-Verify Credentials",
"description": "V30 only.\r\nForce a new Login to verify the credentials are valid.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): everify-read or everify-write ````",
"operationId": "EverifyVerifyCredentialsGet",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "boolean"
}
},
"application/json": {
"schema": {
"type": "boolean"
}
},
"text/json": {
"schema": {
"type": "boolean"
}
},
"application/xml": {
"schema": {
"type": "boolean"
}
},
"text/xml": {
"schema": {
"type": "boolean"
}
}
}
}
}
}
},
"/Hotlists": {
"get": {
"tags": [
"Hotlists"
],
"summary": "Gets the hotlists.",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): hotlist-read or hotlist-write ````",
"operationId": "HotlistsGet",
"parameters": [
{
"name": "OriginTypeId",
"in": "query",
"description": "The hot list's origin type. Supported origin types are 1 (Employee), 2 (Customer), and 3 (Contact).",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "HotlistType",
"in": "query",
"description": "The type of hot list ( static list, saved search or all ).",
"style": "form",
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Enums.HotlistType"
}
},
{
"name": "IncludePublicLists",
"in": "query",
"description": "If on, public hot lists lists of other ServiceReps will be included in the result, along with any private hotlist that\r\nhas been shared with the service rep, or their service rep team. If off, only the hot lists of the current ServiceRep are returned.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "ExlcudeMyLists",
"in": "query",
"description": "Filter used for removing hotlists that are owned by the service rep from the hotlist search results",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "Name",
"in": "query",
"description": "Search for hot lists with a name containing the provided value",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "Description",
"in": "query",
"description": "Search for hot lists with a description containing the provided value",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "Skip",
"in": "query",
"description": "The number of hot lists to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Take",
"in": "query",
"description": "The number of hot lists to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.GetHotlists.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.GetHotlists.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.GetHotlists.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.GetHotlists.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.GetHotlists.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.GetHotlists.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.GetHotlists.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Hotlists"
],
"summary": "Creates a hotlist of type static list.",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): hotlist-write ````",
"operationId": "HotlistsPost",
"requestBody": {
"description": "The request to create a new static list.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.CreateHotlistRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.CreateHotlistRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.CreateHotlistRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.CreateHotlistRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.CreateHotlistRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.CreateHotlistRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.CreateHotlistRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.CreateHotlistRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.Hotlists.CreateHotlist.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.Hotlists.CreateHotlist.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.Hotlists.CreateHotlist.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.Hotlists.CreateHotlist.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.Hotlists.CreateHotlist.Result"
}
}
}
}
}
}
},
"/Hotlists/{hotlistId}": {
"delete": {
"tags": [
"Hotlists"
],
"summary": "Deletes a hotlist.",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): hotlist-write ````",
"operationId": "HotlistsByHotlistIdDelete",
"parameters": [
{
"name": "hotlistId",
"in": "path",
"description": "The id of the hotlist.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
},
"get": {
"tags": [
"Hotlists"
],
"summary": "Gets a hotlist.",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): hotlist-read or hotlist-write ````",
"operationId": "HotlistsByHotlistIdGet",
"parameters": [
{
"name": "hotlistId",
"in": "path",
"description": "The hotlist id.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.Hotlists.GetHotlist.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.Hotlists.GetHotlist.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.Hotlists.GetHotlist.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.Hotlists.GetHotlist.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.Hotlists.GetHotlist.Result"
}
}
}
}
}
},
"put": {
"tags": [
"Hotlists"
],
"summary": "Updates hotlist information. Does not update its members.",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): hotlist-write ````",
"operationId": "HotlistsByHotlistIdPut",
"parameters": [
{
"name": "hotlistId",
"in": "path",
"description": "The id of the hotlist.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The request model to update a hotlist (static list).",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.UpdateHotlistRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.UpdateHotlistRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.UpdateHotlistRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.UpdateHotlistRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.UpdateHotlistRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.UpdateHotlistRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.UpdateHotlistRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.UpdateHotlistRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Hotlists/{hotlistId}/contacts": {
"get": {
"tags": [
"Hotlists"
],
"summary": "Gets contact hotlist members for a given hotlist id.",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): hotlist-read or hotlist-write ````",
"operationId": "HotlistsByHotlistIdContactsGet",
"parameters": [
{
"name": "hotlistId",
"in": "path",
"description": "The hotlist id.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "orderBy",
"in": "query",
"description": "The column to order by. The default order is the members position.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "orderByAscending",
"in": "query",
"description": "The order direction.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.GetContactHotlistMembers.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.GetContactHotlistMembers.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.GetContactHotlistMembers.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.GetContactHotlistMembers.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.GetContactHotlistMembers.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.GetContactHotlistMembers.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.GetContactHotlistMembers.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Hotlists/{hotlistId}/contacts/{hotlistMemberId}": {
"put": {
"tags": [
"Hotlists"
],
"summary": "Updates a hotlist contact member.",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): hotlist-write ````",
"operationId": "HotlistsByHotlistIdContactsByHotlistMemberIdPut",
"parameters": [
{
"name": "hotlistId",
"in": "path",
"description": "The id of the hotlist.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "hotlistMemberId",
"in": "path",
"description": "The id of the hotlist member.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The request model to update a member.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.UpdateHotlistContactMemberRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.UpdateHotlistContactMemberRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.UpdateHotlistContactMemberRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.UpdateHotlistContactMemberRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.UpdateHotlistContactMemberRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.UpdateHotlistContactMemberRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.UpdateHotlistContactMemberRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.UpdateHotlistContactMemberRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Hotlists/{hotlistId}/customers": {
"get": {
"tags": [
"Hotlists"
],
"summary": "Gets customer hotlist members for a given hotlist id.",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): hotlist-read or hotlist-write ````",
"operationId": "HotlistsByHotlistIdCustomersGet",
"parameters": [
{
"name": "hotlistId",
"in": "path",
"description": "The hotlist id.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "orderBy",
"in": "query",
"description": "The column to order by. The default order is the members sort order (position).",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "orderByAscending",
"in": "query",
"description": "The order direction.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.GetCustomerHotlistMembers.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.GetCustomerHotlistMembers.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.GetCustomerHotlistMembers.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.GetCustomerHotlistMembers.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.GetCustomerHotlistMembers.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.GetCustomerHotlistMembers.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.GetCustomerHotlistMembers.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Hotlists/{hotlistId}/customers/{hotlistMemberId}": {
"put": {
"tags": [
"Hotlists"
],
"summary": "Updates a hotlist customer member.",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): hotlist-write ````",
"operationId": "HotlistsByHotlistIdCustomersByHotlistMemberIdPut",
"parameters": [
{
"name": "hotlistId",
"in": "path",
"description": "The id of the hotlist.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "hotlistMemberId",
"in": "path",
"description": "The id of the hotlist member.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The request model to update a member.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.UpdateHotlistCustomerMemberRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.UpdateHotlistCustomerMemberRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.UpdateHotlistCustomerMemberRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.UpdateHotlistCustomerMemberRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.UpdateHotlistCustomerMemberRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.UpdateHotlistCustomerMemberRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.UpdateHotlistCustomerMemberRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.UpdateHotlistCustomerMemberRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Hotlists/{hotlistId}/employees": {
"get": {
"tags": [
"Hotlists"
],
"summary": "Gets employee hotlist members for a given hotlist id.",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): hotlist-read or hotlist-write ````",
"operationId": "HotlistsByHotlistIdEmployeesGet",
"parameters": [
{
"name": "hotlistId",
"in": "path",
"description": "The hotlist id.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "orderBy",
"in": "query",
"description": "The column to order by. The default order is the members sort order (position).",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "orderByAscending",
"in": "query",
"description": "The order direction.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.GetEmployeeHotlistMembers.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.GetEmployeeHotlistMembers.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.GetEmployeeHotlistMembers.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.GetEmployeeHotlistMembers.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.GetEmployeeHotlistMembers.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.GetEmployeeHotlistMembers.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.GetEmployeeHotlistMembers.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Hotlists/{hotlistId}/employees/{hotlistMemberId}": {
"put": {
"tags": [
"Hotlists"
],
"summary": "Updates a hotlist employee member.",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): hotlist-write ````",
"operationId": "HotlistsByHotlistIdEmployeesByHotlistMemberIdPut",
"parameters": [
{
"name": "hotlistId",
"in": "path",
"description": "The id of the hotlist.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "hotlistMemberId",
"in": "path",
"description": "The id of the hotlist member.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The request model to update a member.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.UpdateHotlistEmployeeMemberRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.UpdateHotlistEmployeeMemberRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.UpdateHotlistEmployeeMemberRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.UpdateHotlistEmployeeMemberRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.UpdateHotlistEmployeeMemberRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.UpdateHotlistEmployeeMemberRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.UpdateHotlistEmployeeMemberRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.UpdateHotlistEmployeeMemberRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Hotlists/{hotlistId}/employees/bulk-update": {
"put": {
"tags": [
"Hotlists"
],
"summary": "Bulk update of employee hotlist members.",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): hotlist-write ````",
"operationId": "HotlistsByHotlistIdEmployeesBulkUpdatePut",
"parameters": [
{
"name": "hotlistId",
"in": "path",
"description": "The hotlist id.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The request to bulk update employee members.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.BulkUpdateHotlistEmployeeMembersRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.BulkUpdateHotlistEmployeeMembersRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.BulkUpdateHotlistEmployeeMembersRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.BulkUpdateHotlistEmployeeMembersRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.BulkUpdateHotlistEmployeeMembersRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.BulkUpdateHotlistEmployeeMembersRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.BulkUpdateHotlistEmployeeMembersRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.BulkUpdateHotlistEmployeeMembersRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Hotlists/{hotlistId}/member/{hotlistMemberId}": {
"delete": {
"tags": [
"Hotlists"
],
"summary": "Removes a hotlist member.",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): hotlist-write ````",
"operationId": "HotlistsByHotlistIdMemberByHotlistMemberIdDelete",
"parameters": [
{
"name": "hotlistId",
"in": "path",
"description": "The id of the hotlist.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "hotlistMemberId",
"in": "path",
"description": "The id of the hotlist member.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Hotlists/{hotlistId}/members": {
"post": {
"tags": [
"Hotlists"
],
"summary": "Add members to the given hotlist.",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): hotlist-write ````",
"operationId": "HotlistsByHotlistIdMembersPost",
"parameters": [
{
"name": "hotlistId",
"in": "path",
"description": "The hotlist id.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The request model with members.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.AddMembersToHotlistRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.AddMembersToHotlistRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.AddMembersToHotlistRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.AddMembersToHotlistRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.AddMembersToHotlistRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.AddMembersToHotlistRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.AddMembersToHotlistRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.AddMembersToHotlistRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Hotlists/{hotlistId}/members/validate": {
"post": {
"tags": [
"Hotlists"
],
"summary": "Validate how many entities will be added and how many are already included in the hotlist.",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): hotlist-read or hotlist-write ````",
"operationId": "HotlistsByHotlistIdMembersValidatePost",
"parameters": [
{
"name": "hotlistId",
"in": "path",
"description": "The hotlist id.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The request model with members.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.ValidateHotlistMembersRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.ValidateHotlistMembersRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.ValidateHotlistMembersRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.ValidateHotlistMembersRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.ValidateHotlistMembersRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.ValidateHotlistMembersRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.ValidateHotlistMembersRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.ValidateHotlistMembersRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.Hotlists.ValidateHotlistMembers.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.Hotlists.ValidateHotlistMembers.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.Hotlists.ValidateHotlistMembers.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.Hotlists.ValidateHotlistMembers.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.Hotlists.ValidateHotlistMembers.Result"
}
}
}
}
}
}
},
"/Hotlists/{hotlistId}/share": {
"put": {
"tags": [
"Hotlists"
],
"summary": "Updates the Service Reps and Service Rep Teams that a hotlist has been shared with",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): hotlist-write ````",
"operationId": "HotlistsByHotlistIdSharePut",
"parameters": [
{
"name": "hotlistId",
"in": "path",
"description": "The id of the hotlist",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The request model for updating which users a hotlist is shared with",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.UpdateHotlistShareSettingsRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.UpdateHotlistShareSettingsRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.UpdateHotlistShareSettingsRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.UpdateHotlistShareSettingsRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.UpdateHotlistShareSettingsRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.UpdateHotlistShareSettingsRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.UpdateHotlistShareSettingsRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Hotlists.RequestModels.UpdateHotlistShareSettingsRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Hotlists/{originTypeId}/{originId}/Membership": {
"get": {
"tags": [
"Hotlists"
],
"summary": "Returns hotlists that the indicated record is a member of.",
"description": "Returns your private hotlists, hotlists that are shared with you, and public hotlists that are visible to you,\r\nwhich the indicated record is a member of.\r\nDoes not return saved search hotlists.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): hotlist-read or hotlist-write ````",
"operationId": "HotlistsByOriginTypeIdByOriginIdMembershipGet",
"parameters": [
{
"name": "OriginTypeId",
"in": "path",
"description": "The record's Origin Type. Supported origin types are 1 (Employee), 2 (Customer), and 3 (Contact).",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "OriginId",
"in": "path",
"description": "The record's Origin Id. For Employees, the EmployeeId; for Customers, the CustomerId; for Contacts; the ContactId.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "Name",
"in": "query",
"description": "Search for hotlists with a name containing the provided value",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "Description",
"in": "query",
"description": "Search for hotlists with a description containing the provided value",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "Skip",
"in": "query",
"description": "The number of hotlists to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Take",
"in": "query",
"description": "The number of hotlists to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.GetHotlistMembership.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.GetHotlistMembership.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.GetHotlistMembership.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.GetHotlistMembership.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.GetHotlistMembership.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.GetHotlistMembership.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.GetHotlistMembership.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Hotlists/{originTypeId}/summary": {
"get": {
"tags": [
"Hotlists"
],
"summary": "Get hotlists by member origin type.",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): hotlist-read or hotlist-write ````",
"operationId": "HotlistsByOriginTypeIdSummaryGet",
"parameters": [
{
"name": "originTypeId",
"in": "path",
"description": "The member origin type id.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.GetHotlistsByOriginType.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.GetHotlistsByOriginType.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.GetHotlistsByOriginType.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.GetHotlistsByOriginType.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.GetHotlistsByOriginType.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.GetHotlistsByOriginType.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.GetHotlistsByOriginType.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
},
"deprecated": true
}
},
"/Hotlists/AvailableServiceReps": {
"get": {
"tags": [
"Hotlists"
],
"summary": "Get the Service Reps with whom a Hotlist can be shared",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): hotlist-read or hotlist-write ````",
"operationId": "HotlistsAvailableServiceRepsGet",
"parameters": [
{
"name": "hotlistId",
"in": "query",
"style": "form",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.HotlistAvailableServiceReps.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.HotlistAvailableServiceReps.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.HotlistAvailableServiceReps.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.HotlistAvailableServiceReps.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.HotlistAvailableServiceReps.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.HotlistAvailableServiceReps.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.HotlistAvailableServiceReps.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Hotlists/AvailableTeams": {
"get": {
"tags": [
"Hotlists"
],
"summary": "Get the Service Rep Teams with which a Hotlist can be shared",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): hotlist-read or hotlist-write ````",
"operationId": "HotlistsAvailableTeamsGet",
"parameters": [
{
"name": "hotlistId",
"in": "query",
"style": "form",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.HotlistAvailableTeams.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.HotlistAvailableTeams.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.HotlistAvailableTeams.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.HotlistAvailableTeams.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.HotlistAvailableTeams.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.HotlistAvailableTeams.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.HotlistAvailableTeams.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/HrCenter/{productInstanceId}/cache": {
"delete": {
"tags": [
"HrCenter"
],
"summary": "Delete HRCenter Cache",
"description": "Deletes the cached lists stored in HRCenter so they will be pulled fresh from the database the next time they are needed.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): onboarding-read or onboarding-write ````",
"operationId": "HrCenterByProductInstanceIdCacheDelete",
"parameters": [
{
"name": "productInstanceId",
"in": "path",
"description": "The Id of the product instance.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/HrCenter/{productInstanceId}/languages": {
"get": {
"tags": [
"HrCenter"
],
"summary": "Get HRCenter Languages",
"description": "Gets a list of Languages for the Product Instance.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): onboarding-read or onboarding-write ````",
"operationId": "HrCenterByProductInstanceIdLanguagesGet",
"parameters": [
{
"name": "productInstanceId",
"in": "path",
"description": "The Id of the product instance.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.ProductInstanceLanguageListQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.ProductInstanceLanguageListQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.ProductInstanceLanguageListQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.ProductInstanceLanguageListQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.ProductInstanceLanguageListQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.ProductInstanceLanguageListQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.ProductInstanceLanguageListQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/HrCenter/{productInstanceId}/pages": {
"get": {
"tags": [
"HrCenter"
],
"summary": "Get HRCenter Pages",
"description": "Gets a list of Pages belonging to the Product Instance.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): onboarding-read or onboarding-write ````",
"operationId": "HrCenterByProductInstanceIdPagesGet",
"parameters": [
{
"name": "productInstanceId",
"in": "path",
"description": "The Id of the product instance.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "includeInactivePages",
"in": "query",
"description": "If set to true both active and inactive pages will be returned.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "primaryActorType",
"in": "query",
"description": "An optional parameter used to limit the results to pages that can be assigned to only the specified actor type.",
"style": "form",
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Enums.ActorType"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.ProductInstancePagesListQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.ProductInstancePagesListQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.ProductInstancePagesListQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.ProductInstancePagesListQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.ProductInstancePagesListQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.ProductInstancePagesListQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.ProductInstancePagesListQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/HrCenter/{productInstanceId}/workflows": {
"get": {
"tags": [
"HrCenter"
],
"summary": "Get HRCenter Workflows",
"description": "Gets a list of Workflows belonging to the Product Instance.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): onboarding-read or onboarding-write ````",
"operationId": "HrCenterByProductInstanceIdWorkflowsGet",
"parameters": [
{
"name": "productInstanceId",
"in": "path",
"description": "The Id of the product instance.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "includeInactiveWorkflows",
"in": "query",
"description": "If set to true both active and inactive workflows will be returned.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "primaryActorType",
"in": "query",
"description": "An optional parameter used to limit the results to workflows that can be assigned to only the specified actor type.",
"style": "form",
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Enums.ActorType"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.ProductInstanceWorkflowListQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.ProductInstanceWorkflowListQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.ProductInstanceWorkflowListQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.ProductInstanceWorkflowListQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.ProductInstanceWorkflowListQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.ProductInstanceWorkflowListQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.ProductInstanceWorkflowListQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/HrCenter/{productInstanceId}/workflows/{workflowId}/steps": {
"get": {
"tags": [
"HrCenter"
],
"summary": "Get HRCenter Workflow Steps",
"description": "Gets a list of Steps belonging to the Workflow.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): onboarding-read or onboarding-write ````",
"operationId": "HrCenterByProductInstanceIdWorkflowsByWorkflowIdStepsGet",
"parameters": [
{
"name": "productInstanceId",
"in": "path",
"description": "The Id of the product instance.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "workflowId",
"in": "path",
"description": "The Id of the workflow. Valid Workflows can be found in the HRCenter Workflows Datalist.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "includeInactiveSteps",
"in": "query",
"description": "If set to true both active and inactive steps will be returned.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.ProductInstanceStepsListQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.ProductInstanceStepsListQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.ProductInstanceStepsListQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.ProductInstanceStepsListQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.ProductInstanceStepsListQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.ProductInstanceStepsListQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.ProductInstanceStepsListQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/HrCenter/{productInstanceId}/workflows/{workflowId}/steps/{stepId}/pages": {
"get": {
"tags": [
"HrCenter"
],
"summary": "Get HRCenter Workflow Step Pages",
"description": "Gets a list of Pages belonging to the Step.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): onboarding-read or onboarding-write ````",
"operationId": "HrCenterByProductInstanceIdWorkflowsByWorkflowIdStepsByStepIdPagesGet",
"parameters": [
{
"name": "productInstanceId",
"in": "path",
"description": "The Id of the product instance.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "workflowId",
"in": "path",
"description": "The Id of the workflow. Valid Workflows can be found in the HRCenter Workflows Datalist.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "stepId",
"in": "path",
"description": "The Id of the step. Valid Steps can be found in the HRCenter Steps Datalist.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.ProductInstanceWorkflowStepPagesListQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.ProductInstanceWorkflowStepPagesListQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.ProductInstanceWorkflowStepPagesListQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.ProductInstanceWorkflowStepPagesListQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.ProductInstanceWorkflowStepPagesListQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.ProductInstanceWorkflowStepPagesListQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.ProductInstanceWorkflowStepPagesListQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/HrCenter/jobOrderJobTitles": {
"get": {
"tags": [
"HrCenter"
],
"summary": "Get JobOrder Public Job Titles",
"description": "Gets a list of job orders with their public job titles\n \n```` Allows roles: Service ````\n \n```` Requires scope(s): onboarding-read or onboarding-write ````",
"operationId": "HrCenterJobOrderJobTitlesGet",
"parameters": [
{
"name": "jobOrderId",
"in": "query",
"description": "JobOrderId to look up. Repeat this parameter to look up multiple JobOrders.",
"required": true,
"style": "form",
"schema": {
"minItems": 1,
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.HrCenter.Service.Commands.GetPublicJobTitleList.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.HrCenter.Service.Commands.GetPublicJobTitleList.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.HrCenter.Service.Commands.GetPublicJobTitleList.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.HrCenter.Service.Commands.GetPublicJobTitleList.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.HrCenter.Service.Commands.GetPublicJobTitleList.Result"
}
}
}
}
}
}
},
"/HrCenter/Password": {
"put": {
"tags": [
"HrCenter"
],
"summary": "Change WebUser account password",
"description": "\n \n```` Allows roles: Service ````\n \n```` Requires scope(s): webuser-write ````",
"operationId": "HrCenterPasswordPut",
"requestBody": {
"description": "Body of the request containing information about the WebUser account",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.HrCenter.API.Models.ChangeWebUserPasswordRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.HrCenter.API.Models.ChangeWebUserPasswordRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.HrCenter.API.Models.ChangeWebUserPasswordRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.HrCenter.API.Models.ChangeWebUserPasswordRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.HrCenter.API.Models.ChangeWebUserPasswordRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.HrCenter.API.Models.ChangeWebUserPasswordRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.HrCenter.API.Models.ChangeWebUserPasswordRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.HrCenter.API.Models.ChangeWebUserPasswordRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/HrCenter/productInstances": {
"get": {
"tags": [
"HrCenter"
],
"summary": "Get HRCenter Product Instances",
"description": "Gets a list of Product Instances that represent HRCenter Tenants.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): onboarding-read or onboarding-write ````",
"operationId": "HrCenterProductInstancesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "includeDeprecated",
"in": "query",
"description": "Set to true if you want the result to include deprecated product instances.",
"style": "form",
"schema": {
"type": "boolean",
"default": true
}
}
],
"responses": {
"204": {
"description": "No Content",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ProductInstanceListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ProductInstanceListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ProductInstanceListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ProductInstanceListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ProductInstanceListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ProductInstanceListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ProductInstanceListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/HrCenter/stepStatuses": {
"get": {
"tags": [
"HrCenter"
],
"summary": "Get HRCenter Step Statuses",
"description": "Gets a list of Step Statuses used by HRCenter.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): onboarding-read or onboarding-write ````",
"operationId": "HrCenterStepStatusesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"204": {
"description": "No Content",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.StepStatusListQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.StepStatusListQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.StepStatusListQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.StepStatusListQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.StepStatusListQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.StepStatusListQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.StepStatusListQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/HrCenter/WebUser": {
"get": {
"tags": [
"HrCenter"
],
"summary": "Get WebUser account summary",
"description": "Gets WebUser account summary information by username and product instance\n \n```` Allows roles: Service ````\n \n```` Requires scope(s): onboarding-read or onboarding-write ````",
"operationId": "HrCenterWebUserGet",
"parameters": [
{
"name": "username",
"in": "query",
"description": "The WebUser account username",
"required": true,
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "productInstanceId",
"in": "query",
"description": "The Id of the product instance",
"required": true,
"style": "form",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.HrCenter.Service.Commands.WebUserAccountSummaryQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.HrCenter.Service.Commands.WebUserAccountSummaryQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.HrCenter.Service.Commands.WebUserAccountSummaryQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.HrCenter.Service.Commands.WebUserAccountSummaryQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.HrCenter.Service.Commands.WebUserAccountSummaryQuery.Result"
}
}
}
}
}
}
},
"/JobOrders": {
"post": {
"tags": [
"JobOrders"
],
"summary": "Create Job Order",
"description": "Creates an order with the details specified in the request.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-write ````",
"operationId": "JobOrdersPost",
"requestBody": {
"description": "The post payload containing the customer to create the job order for and the type of job order to create.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.CreateJobOrderCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.CreateJobOrderCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.CreateJobOrderCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.CreateJobOrderCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.CreateJobOrderCommand.Result"
}
}
}
}
}
}
},
"/JobOrders/{id}": {
"get": {
"tags": [
"JobOrders"
],
"summary": "Get Job Order Details",
"description": "Gets detailed information about the specified job order.\n \n```` Allows roles: ServiceRep, WebUserEmployee, Service ````\n \n```` Requires scope(s): order-read or order-write ````",
"operationId": "JobOrdersByIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "culture",
"in": "query",
"description": "Optional parameter to pull locale specific job order details.",
"style": "form",
"schema": {
"maxLength": 20,
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.JobOrders.JobOrderDetails.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.JobOrders.JobOrderDetails.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.JobOrders.JobOrderDetails.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.JobOrders.JobOrderDetails.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.JobOrders.JobOrderDetails.Result"
}
}
}
}
}
},
"patch": {
"tags": [
"JobOrders"
],
"summary": "Patch Job Order Basic Information",
"description": "\r\n\r\n Allows for Json patching to be performed against basic job order fields.\r\n More information about PATCHING, see https://developer.ontempworks.com/docs/your-request\r\n \r\n\r\n\r\n Valid Patch paths: /WorkerCompCodeId (int), /AlternateJobOrderId (string), /BurdenTypeId (int?), /WorksiteId (int), /Directions (string), /JobTitleId (int), /JobOrderTypeId (int), /PositionsRequired (short), /VMSPositionsRequired (int), /JobDescription (string), /DressCode (string), /StartDate (DateTime?), /EstimatedEndDate (DateTime?), /ShiftId (Guid?), /StartTime (string), \r\n /EndTime (string), /JobOrderDurationId (int), /JobOrderShiftNotes (string), /SafetyNotes (string), /IsScheduledForSunday (bool), /IsScheduledForMonday (bool), /IsScheduledForTuesday (bool), /IsScheduledForWednesday (bool), /IsScheduledForThursday (bool), /IsScheduledForFriday (bool), /IsScheduledForSaturday (bool), /JobOrderStatusId (int), /SalesTeamId (int), \r\n /BranchId (int), /DoNotAutoClose (bool), /UsesTimeClock (bool), /UsesPeopleNet (bool), /ServiceRepId (int), /Notes (string), /PurchaseOrderId (int?), /Location (string), /MileageRate (decimal?), /CostCenter (string), /SubEntity (string), /AccountCode (string), /CustomerSkill (string), /CheckDelivery (string), /RequisitionNumber (string), /AlternateRequisitionNumber (string), \r\n /RequisitionEndDate (DateTime?), /CustomerExtra1 (string), /CustomerExtra2 (string), /CustomerExtra3 (string), /PayrollNote (string), /PublicJobTitle (string), /PublicJobDescription (string), /PublicPostingDate (DateTime?), /DoNotPostPublicly (bool), /PrimaryMessageId (long?), /PublicJobDescriptionContentType (string), /RemoteWorkStatusId(int?)\r\n /RequiredSkills (string), /AdditionalSkills (string), /IdealCandidateDescription (string), /TopKnockOutFactors (string), /TopSuccessAttributesForRole (string), /PrimaryResponsibilities (string), /SalaryRange (string), /PeopleWhoHaveSeenTheJobOrder (string), /ReasonForOpenPosition (string), /JobBenefits (string), /InterviewProcess (string)\r\n \n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-write ````",
"operationId": "JobOrdersByIdPatch",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "A Json array of patch operations to be performed.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":"SampleNote","path":"/Notes","op":"replace"},{"value":"2023-01-31","path":"/StartDate","op":"add"},{"path":"/StartDate","op":"remove"},{"path":"/PayrollNote","op":"copy","from":"/EstimatedEndDate"},{"path":"/PayrollNote","op":"move","from":"/EstimatedEndDate"},{"value":"SampleNote","path":"/Notes","op":"test"}]
},
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":"SampleNote","path":"/Notes","op":"replace"},{"value":"2023-01-31","path":"/StartDate","op":"add"},{"path":"/StartDate","op":"remove"},{"path":"/PayrollNote","op":"copy","from":"/EstimatedEndDate"},{"path":"/PayrollNote","op":"move","from":"/EstimatedEndDate"},{"value":"SampleNote","path":"/Notes","op":"test"}]
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":"SampleNote","path":"/Notes","op":"replace"},{"value":"2023-01-31","path":"/StartDate","op":"add"},{"path":"/StartDate","op":"remove"},{"path":"/PayrollNote","op":"copy","from":"/EstimatedEndDate"},{"path":"/PayrollNote","op":"move","from":"/EstimatedEndDate"},{"value":"SampleNote","path":"/Notes","op":"test"}]
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":"SampleNote","path":"/Notes","op":"replace"},{"value":"2023-01-31","path":"/StartDate","op":"add"},{"path":"/StartDate","op":"remove"},{"path":"/PayrollNote","op":"copy","from":"/EstimatedEndDate"},{"path":"/PayrollNote","op":"move","from":"/EstimatedEndDate"},{"value":"SampleNote","path":"/Notes","op":"test"}]
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":"SampleNote","path":"/Notes","op":"replace"},{"value":"2023-01-31","path":"/StartDate","op":"add"},{"path":"/StartDate","op":"remove"},{"path":"/PayrollNote","op":"copy","from":"/EstimatedEndDate"},{"path":"/PayrollNote","op":"move","from":"/EstimatedEndDate"},{"value":"SampleNote","path":"/Notes","op":"test"}]
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": "\r\n \r\n \r\n replace\r\n /Notes\r\n SampleNote\r\n \r\n \r\n \r\n add\r\n /StartDate\r\n 2023-01-31\r\n \r\n \r\n \r\n remove\r\n /StartDate\r\n \r\n \r\n \r\n /EstimatedEndDate\r\n copy\r\n /PayrollNote\r\n \r\n \r\n \r\n /EstimatedEndDate\r\n move\r\n /PayrollNote\r\n \r\n \r\n \r\n \r\n test\r\n /Notes\r\n SampleNote\r\n \r\n"
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": "\r\n \r\n \r\n replace\r\n /Notes\r\n SampleNote\r\n \r\n \r\n \r\n add\r\n /StartDate\r\n 2023-01-31\r\n \r\n \r\n \r\n remove\r\n /StartDate\r\n \r\n \r\n \r\n /EstimatedEndDate\r\n copy\r\n /PayrollNote\r\n \r\n \r\n \r\n /EstimatedEndDate\r\n move\r\n /PayrollNote\r\n \r\n \r\n \r\n \r\n test\r\n /Notes\r\n SampleNote\r\n \r\n"
},
"application/*+xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": "\r\n \r\n \r\n replace\r\n /Notes\r\n SampleNote\r\n \r\n \r\n \r\n add\r\n /StartDate\r\n 2023-01-31\r\n \r\n \r\n \r\n remove\r\n /StartDate\r\n \r\n \r\n \r\n /EstimatedEndDate\r\n copy\r\n /PayrollNote\r\n \r\n \r\n \r\n /EstimatedEndDate\r\n move\r\n /PayrollNote\r\n \r\n \r\n \r\n \r\n test\r\n /Notes\r\n SampleNote\r\n \r\n"
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/JobOrders/{id}/absence": {
"get": {
"tags": [
"JobOrders"
],
"summary": "Get Job Order Absence",
"description": "Gets the absence for the job order. Only one absence is allowed per job order.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-write ````",
"operationId": "JobOrdersByIdAbsenceGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.Absence.JobOrderAbsenceQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.Absence.JobOrderAbsenceQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.Absence.JobOrderAbsenceQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.Absence.JobOrderAbsenceQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.Absence.JobOrderAbsenceQuery.Result"
}
}
}
}
}
},
"post": {
"tags": [
"JobOrders"
],
"summary": "Create Job Order Absence",
"description": "Creates a job order absence. Only one absence is allowed per order.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-write ````",
"operationId": "JobOrdersByIdAbsencePost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the Job Order",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The request object containing the job order absence details.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.JobOrderAbsenceRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.JobOrderAbsenceRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.JobOrderAbsenceRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.JobOrderAbsenceRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.JobOrderAbsenceRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.JobOrderAbsenceRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.JobOrderAbsenceRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.JobOrderAbsenceRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.Absence.CreateJobOrderAbsenceCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.Absence.CreateJobOrderAbsenceCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.Absence.CreateJobOrderAbsenceCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.Absence.CreateJobOrderAbsenceCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.Absence.CreateJobOrderAbsenceCommand.Result"
}
}
}
}
}
},
"put": {
"tags": [
"JobOrders"
],
"summary": "Update Job Order Absence",
"description": "Updates the absence on a job order. Only one absence is allowed per job order.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-write ````",
"operationId": "JobOrdersByIdAbsencePut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the Job Order",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The request object containing the job order absence details.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.JobOrderAbsenceRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.JobOrderAbsenceRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.JobOrderAbsenceRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.JobOrderAbsenceRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.JobOrderAbsenceRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.JobOrderAbsenceRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.JobOrderAbsenceRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.JobOrderAbsenceRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
},
"delete": {
"tags": [
"JobOrders"
],
"summary": "Delete Job Order Absence",
"description": "Deletes a job order absence.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-write ````",
"operationId": "JobOrdersByIdAbsenceDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/JobOrders/{id}/adjustments": {
"get": {
"tags": [
"JobOrders"
],
"summary": "Get Adjustments",
"description": "Gets a list of adjustments for the specified job order.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-read or order-write ````",
"operationId": "JobOrdersByIdAdjustmentsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of adjustments to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of adjustments to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.Adjustments.JobOrderAdjustments.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.Adjustments.JobOrderAdjustments.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.Adjustments.JobOrderAdjustments.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.Adjustments.JobOrderAdjustments.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.Adjustments.JobOrderAdjustments.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.Adjustments.JobOrderAdjustments.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.Adjustments.JobOrderAdjustments.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"JobOrders"
],
"summary": "Add Job Order Adjustment",
"description": "Adds an adjustment to a job order.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-write ````",
"operationId": "JobOrdersByIdAdjustmentsPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Id of the job order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "A model containing the information to create a new job order adjustment",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderAdjustmentRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderAdjustmentRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderAdjustmentRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderAdjustmentRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderAdjustmentRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderAdjustmentRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderAdjustmentRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderAdjustmentRequest"
}
}
}
},
"responses": {
"201": {
"description": "Id of the created job order adjustment",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.Adjustments.CreateJobOrderAdjustment.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.Adjustments.CreateJobOrderAdjustment.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.Adjustments.CreateJobOrderAdjustment.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.Adjustments.CreateJobOrderAdjustment.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.Adjustments.CreateJobOrderAdjustment.Result"
}
}
}
}
}
}
},
"/JobOrders/{id}/adjustments/{jobOrderAdjustmentId}": {
"get": {
"tags": [
"JobOrders"
],
"summary": "Get JobOrder Adjustment details",
"description": "Gets the job order adjustment details.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-read or order-write ````",
"operationId": "JobOrdersByIdAdjustmentsByJobOrderAdjustmentIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "jobOrderAdjustmentId",
"in": "path",
"description": "The Id of the job order adjustment",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.Adjustments.JobOrderAdjustments.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.Adjustments.JobOrderAdjustments.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.Adjustments.JobOrderAdjustments.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.Adjustments.JobOrderAdjustments.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.Adjustments.JobOrderAdjustments.Result"
}
}
}
}
}
},
"put": {
"tags": [
"JobOrders"
],
"summary": "Update Job Order Adjustment",
"description": "Updates a job order adjustment.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-write ````",
"operationId": "JobOrdersByIdAdjustmentsByJobOrderAdjustmentIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Id of the job order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "jobOrderAdjustmentId",
"in": "path",
"description": "The Id of the updated job order adjustment",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "A model containing the information to update an existing job order adjustment",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderAdjustmentRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderAdjustmentRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderAdjustmentRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderAdjustmentRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderAdjustmentRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderAdjustmentRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderAdjustmentRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderAdjustmentRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
},
"delete": {
"tags": [
"JobOrders"
],
"summary": "Delete Job Order Adjustment",
"description": "Deletes a job order adjustment.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-write ````",
"operationId": "JobOrdersByIdAdjustmentsByJobOrderAdjustmentIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Id of the job order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "jobOrderAdjustmentId",
"in": "path",
"description": "The Id of the deleted job order adjustment",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/JobOrders/{id}/adjustments/{jobOrderAdjustmentId}/validate": {
"put": {
"tags": [
"JobOrders"
],
"summary": "Validates the request model to update job order adjustment.",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-write ````",
"operationId": "JobOrdersByIdAdjustmentsByJobOrderAdjustmentIdValidatePut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Id of the job order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "jobOrderAdjustmentId",
"in": "path",
"description": "The Id of the updated job order adjustment",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "A model containing the information to update an existing job order adjustment",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderAdjustmentRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderAdjustmentRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderAdjustmentRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderAdjustmentRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderAdjustmentRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderAdjustmentRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderAdjustmentRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderAdjustmentRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/JobOrders/{id}/adjustments/validate": {
"post": {
"tags": [
"JobOrders"
],
"summary": "Validates the request model to add an adjustment to a job order.",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-write ````",
"operationId": "JobOrdersByIdAdjustmentsValidatePost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Id of the job order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The update request model.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderAdjustmentRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderAdjustmentRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderAdjustmentRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderAdjustmentRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderAdjustmentRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderAdjustmentRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderAdjustmentRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderAdjustmentRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/JobOrders/{id}/assignmentRestrictions": {
"post": {
"tags": [
"JobOrders"
],
"summary": "Create Assignment Restriction Session",
"description": "Creates and processes an assignment restriction session according to the details specified in the request body.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): assignment-write and ordercandidate-write ````",
"operationId": "JobOrdersByIdAssignmentRestrictionsPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Id of the job order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The request body containing the information needed to initialize a new session.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateAssignmentRestrictionSessionRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateAssignmentRestrictionSessionRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateAssignmentRestrictionSessionRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateAssignmentRestrictionSessionRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateAssignmentRestrictionSessionRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateAssignmentRestrictionSessionRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateAssignmentRestrictionSessionRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateAssignmentRestrictionSessionRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.AssignmentRestriction.CreateAssignmentRestrictionSessionCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.AssignmentRestriction.CreateAssignmentRestrictionSessionCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.AssignmentRestriction.CreateAssignmentRestrictionSessionCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.AssignmentRestriction.CreateAssignmentRestrictionSessionCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.AssignmentRestriction.CreateAssignmentRestrictionSessionCommand.Result"
}
}
}
}
}
}
},
"/JobOrders/{id}/assignmentRestrictions/{assignmentRestrictionSessionId}": {
"get": {
"tags": [
"JobOrders"
],
"summary": "Get Assignment Restriction Session Details",
"description": "Gets details about the specified assignment restriction session.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): assignment-write and ordercandidate-write ````",
"operationId": "JobOrdersByIdAssignmentRestrictionsByAssignmentRestrictionSessionIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Id of the job order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "assignmentRestrictionSessionId",
"in": "path",
"description": "The Id of the assignment restriction session.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.AssignmentRestriction.AssignmentRestrictionSessionQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.AssignmentRestriction.AssignmentRestrictionSessionQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.AssignmentRestriction.AssignmentRestrictionSessionQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.AssignmentRestriction.AssignmentRestrictionSessionQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.AssignmentRestriction.AssignmentRestrictionSessionQuery.Result"
}
}
}
}
}
}
},
"/JobOrders/{id}/assignmentRestrictions/{assignmentRestrictionSessionId}/approve": {
"put": {
"tags": [
"JobOrders"
],
"summary": "Approve Assignment Restriction Session",
"description": "Approves all unapproved results for the session that can be approved. Use the Approve Assignment Restriction Session Result endpoint to approve a specific result.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): assignment-write and ordercandidate-write ````",
"operationId": "JobOrdersByIdAssignmentRestrictionsByAssignmentRestrictionSessionIdApprovePut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Id of the job order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "assignmentRestrictionSessionId",
"in": "path",
"description": "The Id of the assignment restriction session.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/JobOrders/{id}/assignmentRestrictions/{assignmentRestrictionSessionId}/reprocess": {
"put": {
"tags": [
"JobOrders"
],
"summary": "Reprocess Assignment Restriction Session",
"description": "Re-evaluates the restriction rules for the specified session. This can only be used on sessions that are not complete.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): assignment-write and ordercandidate-write ````",
"operationId": "JobOrdersByIdAssignmentRestrictionsByAssignmentRestrictionSessionIdReprocessPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Id of the job order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "assignmentRestrictionSessionId",
"in": "path",
"description": "The Id of the assignment restriction session.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.AssignmentRestriction.GenerateAssignmentRestrictionsCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.AssignmentRestriction.GenerateAssignmentRestrictionsCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.AssignmentRestriction.GenerateAssignmentRestrictionsCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.AssignmentRestriction.GenerateAssignmentRestrictionsCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.AssignmentRestriction.GenerateAssignmentRestrictionsCommand.Result"
}
}
}
}
}
}
},
"/JobOrders/{id}/assignmentRestrictions/{assignmentRestrictionSessionId}/results": {
"get": {
"tags": [
"JobOrders"
],
"summary": "Get Assignment Restriction Session Results",
"description": "Gets the results of the specified assignment restriction session.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): assignment-write and ordercandidate-write ````",
"operationId": "JobOrdersByIdAssignmentRestrictionsByAssignmentRestrictionSessionIdResultsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Id of the job order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "assignmentRestrictionSessionId",
"in": "path",
"description": "The Id of the assignment restriction session.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.AssignmentRestriction.AssignmentRestrictionSessionResultsQuery.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.AssignmentRestriction.AssignmentRestrictionSessionResultsQuery.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.AssignmentRestriction.AssignmentRestrictionSessionResultsQuery.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.AssignmentRestriction.AssignmentRestrictionSessionResultsQuery.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.AssignmentRestriction.AssignmentRestrictionSessionResultsQuery.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.AssignmentRestriction.AssignmentRestrictionSessionResultsQuery.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.AssignmentRestriction.AssignmentRestrictionSessionResultsQuery.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/JobOrders/{id}/assignmentRestrictions/{assignmentRestrictionSessionId}/results/{assignmentRestrictionResultId}/approve": {
"put": {
"tags": [
"JobOrders"
],
"summary": "Approve Assignment Restriction Session Result",
"description": "Approves the results of the specified assignment restriction session result. Use this endpoint to approve a specific result. The Approve Assignment Restriction Session endpoint should be used to approve all results.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): assignment-write and ordercandidate-write ````",
"operationId": "JobOrdersByIdAssignmentRestrictionsByAssignmentRestrictionSessionIdResultsByAssignmentRestrictionResultIdApprovePut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Id of the job order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "assignmentRestrictionSessionId",
"in": "path",
"description": "The Id of the assignment restriction session.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "assignmentRestrictionResultId",
"in": "path",
"description": "The Id of the assignment restriction result to approve.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/JobOrders/{id}/assignments": {
"get": {
"tags": [
"JobOrders"
],
"summary": "Get Assignments",
"description": "Gets a list of assignments for the specified job order. The assignments are ordered by job title then by start date from newest to the oldest.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-read or order-write ````",
"operationId": "JobOrdersByIdAssignmentsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "Skip",
"in": "query",
"description": "The number of assignments to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Take",
"in": "query",
"description": "The number of assignments to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "IsActive",
"in": "query",
"description": "Searches for assignments that are active or inactive based upon the provided value. Leave null to return all.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "StartDate",
"in": "query",
"description": "An optional parameter. Only assignments for which the employee was working during or after\r\nthe specified date will be returned.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "EndDate",
"in": "query",
"description": "An optional parameter. Only assignments for which the employee was working during or before\r\nthe specified date will be returned.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "CanGenerateTimecard",
"in": "query",
"description": "Optional filter which limits the list of assignments to those which can generate a timecard or not.\r\nDo not specify a value to return all",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "OrderBy",
"in": "query",
"description": "Used to order the results by one of the returned columns.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "OrderByAscending",
"in": "query",
"description": "Used to specify the sort order. If left null, the system will order ascending automatically.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "AssignmentStatusId",
"in": "query",
"description": "Optional filter for assignment status Id. Ref: /datalists/assignmentStatuses",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Culture",
"in": "query",
"description": "Optional filter to return the translated texts in the given culture.",
"style": "form",
"schema": {
"maxLength": 20,
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Assignments.AssignmentSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Assignments.AssignmentSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Assignments.AssignmentSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Assignments.AssignmentSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Assignments.AssignmentSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Assignments.AssignmentSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Assignments.AssignmentSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/JobOrders/{id}/calculateGrossProfit": {
"post": {
"tags": [
"JobOrders"
],
"summary": "Calculate Gross Profit for a Job Order",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-read or order-write ````",
"operationId": "JobOrdersByIdCalculateGrossProfitPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "Request Body",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.CalculateGrossProfitRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.CalculateGrossProfitRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.CalculateGrossProfitRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.CalculateGrossProfitRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.CalculateGrossProfitRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.CalculateGrossProfitRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.CalculateGrossProfitRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.CalculateGrossProfitRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.CalculateGrossProfitResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.CalculateGrossProfitResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.CalculateGrossProfitResult"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.CalculateGrossProfitResult"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.CalculateGrossProfitResult"
}
}
}
}
}
}
},
"/JobOrders/{id}/candidatePreferences": {
"get": {
"tags": [
"JobOrders"
],
"summary": "Get Job Order Candidate Preferences",
"description": "Gets Candidate Preferences for the specified Job Order if it exists.\r\nReturns a NoContent if no such information is available.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-read or order-write ````",
"operationId": "JobOrdersByIdCandidatePreferencesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderCandidatePreferences.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderCandidatePreferences.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderCandidatePreferences.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderCandidatePreferences.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderCandidatePreferences.Result"
}
}
}
},
"204": {
"description": "No Content"
}
}
},
"put": {
"tags": [
"JobOrders"
],
"summary": "Update Job Order candidate preferences details",
"description": "Updates candidate preferences details\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-write ````",
"operationId": "JobOrdersByIdCandidatePreferencesPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The body of the request containing the updated candidate preferences details.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderCandidatePreferencesRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderCandidatePreferencesRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderCandidatePreferencesRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderCandidatePreferencesRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderCandidatePreferencesRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderCandidatePreferencesRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderCandidatePreferencesRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderCandidatePreferencesRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/JobOrders/{id}/candidates": {
"get": {
"tags": [
"JobOrders"
],
"summary": "Get Job Order Candidates",
"description": "Gets the list of candidates for the specified job order.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): ordercandidate-read or ordercandidate-write ````",
"operationId": "JobOrdersByIdCandidatesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Id of the job order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "JobOrderCandidateStatusId",
"in": "query",
"description": "If provided, searches for candidacies with a JobOrderCandidateStatusId that equals the provided value.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "OrderBy",
"in": "query",
"description": "Used to order the results by one of the returned columns. By default, the system sorts by Rank, then LastName, then FirstName.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "OrderByAscending",
"in": "query",
"description": "Used to specify the sort order. If left null, the system will order ascending automatically.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "Skip",
"in": "query",
"description": "The number of candidates to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Take",
"in": "query",
"description": "The number of candidates to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "RestrictToActiveCandidacies",
"in": "query",
"description": "If set to true only active candidates will be returned. If not set, both active and inactive candidates will be returned.",
"style": "form",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.JobOrderCandidatesQuery.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.JobOrderCandidatesQuery.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.JobOrderCandidatesQuery.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.JobOrderCandidatesQuery.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.JobOrderCandidatesQuery.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.JobOrderCandidatesQuery.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.JobOrderCandidatesQuery.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"JobOrders"
],
"summary": "Create Job Order Candidate",
"description": "Makes an employee a candidate for a job order. Before an employee can be made a candidate, they must be vetted\r\nby an assignment restriction session and have no results or all of the results approved. An assignment restriction\r\nsession can be started at the jobOrder/{orderId}/assignmentRestriction endpoint.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): ordercandidate-write ````",
"operationId": "JobOrdersByIdCandidatesPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Id of the job order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "A model containing the information with which to create the new job order candidate",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderCandidateRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderCandidateRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderCandidateRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderCandidateRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderCandidateRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderCandidateRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderCandidateRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderCandidateRequest"
}
}
}
},
"responses": {
"201": {
"description": "Id of the new job order candidate",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.CreateJobOrderCandidateCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.CreateJobOrderCandidateCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.CreateJobOrderCandidateCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.CreateJobOrderCandidateCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.CreateJobOrderCandidateCommand.Result"
}
}
}
}
}
}
},
"/JobOrders/{id}/candidates/{jobOrderCandidateId}": {
"get": {
"tags": [
"JobOrders"
],
"summary": "Get Job Order Candidate Details",
"description": "Gets detailed information about the specified job order candidate.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): ordercandidate-read or ordercandidate-write ````",
"operationId": "JobOrdersByIdCandidatesByJobOrderCandidateIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Id of the job order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "jobOrderCandidateId",
"in": "path",
"description": "Id of the job order candidate.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderCandidatesQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderCandidatesQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderCandidatesQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderCandidatesQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderCandidatesQuery.Result"
}
}
}
}
}
},
"put": {
"tags": [
"JobOrders"
],
"summary": "Update Job Order Candidate Details",
"description": "Updates the details of a job order candidate.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): ordercandidate-write ````",
"operationId": "JobOrdersByIdCandidatesByJobOrderCandidateIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Id of the job order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "jobOrderCandidateId",
"in": "path",
"description": "Id of the job order candidate.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The body of the request containing the updated candidate values.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderCandidateRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderCandidateRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderCandidateRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderCandidateRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderCandidateRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderCandidateRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderCandidateRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderCandidateRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
},
"delete": {
"tags": [
"JobOrders"
],
"summary": "Delete Job Order Candidate",
"description": "Deletes the specified job order candidate.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): ordercandidate-write ````",
"operationId": "JobOrdersByIdCandidatesByJobOrderCandidateIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Id of the job order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "jobOrderCandidateId",
"in": "path",
"description": "Id of the job order candidate.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/JobOrders/{id}/candidates/search": {
"post": {
"tags": [
"JobOrders"
],
"summary": "Search Job Order Candidates",
"description": "Searches the list of candidates for the specified job order.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): ordercandidate-read or ordercandidate-write ````",
"operationId": "JobOrdersByIdCandidatesSearchPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Id of the job order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "A request with filter and sort parameters.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.SearchJobOrderCandidatesRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.SearchJobOrderCandidatesRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.SearchJobOrderCandidatesRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.SearchJobOrderCandidatesRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.SearchJobOrderCandidatesRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.SearchJobOrderCandidatesRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.SearchJobOrderCandidatesRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.SearchJobOrderCandidatesRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.JobOrderCandidatesQuery.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.JobOrderCandidatesQuery.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.JobOrderCandidatesQuery.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.JobOrderCandidatesQuery.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.JobOrderCandidatesQuery.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.JobOrderCandidatesQuery.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.JobOrderCandidatesQuery.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/JobOrders/{id}/candidates/summary": {
"get": {
"tags": [
"JobOrders"
],
"summary": "Get Job Order Candidates Summary",
"description": "Gets the number of candidates in each status for the specified job order.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): ordercandidate-read or ordercandidate-write ````",
"operationId": "JobOrdersByIdCandidatesSummaryGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Id of the job order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of candidate statuses to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of candidate statuses to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.JobOrderCandidatesSummary.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.JobOrderCandidatesSummary.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.JobOrderCandidatesSummary.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.JobOrderCandidatesSummary.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.JobOrderCandidatesSummary.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.JobOrderCandidatesSummary.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.JobOrderCandidatesSummary.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/JobOrders/{id}/contactRoles": {
"get": {
"tags": [
"JobOrders"
],
"summary": "Get Contacts",
"description": "Gets a list of contacts and their roles for the specified job order. The contacts are ordered by last name then first name.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-read or order-write ````",
"operationId": "JobOrdersByIdContactRolesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of contacts to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of contacts to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.JobOrderContactsQuery.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.JobOrderContactsQuery.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.JobOrderContactsQuery.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.JobOrderContactsQuery.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.JobOrderContactsQuery.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.JobOrderContactsQuery.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.JobOrderContactsQuery.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"JobOrders"
],
"summary": "Add Contact To Role",
"description": "Adds a contact in the specified role to the job order.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-write ````",
"operationId": "JobOrdersByIdContactRolesPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The body of the request containing information about the new contact role.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderContactRoleRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderContactRoleRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderContactRoleRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderContactRoleRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderContactRoleRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderContactRoleRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderContactRoleRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderContactRoleRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.CreateJobOrderContactRoleCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.CreateJobOrderContactRoleCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.CreateJobOrderContactRoleCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.CreateJobOrderContactRoleCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.CreateJobOrderContactRoleCommand.Result"
}
}
}
}
}
}
},
"/JobOrders/{id}/contactRoles/{jobOrderContactRoleId}": {
"delete": {
"tags": [
"JobOrders"
],
"summary": "Remove Contact From Role",
"description": "Removes a contact in the specified role from the job order.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-write ````",
"operationId": "JobOrdersByIdContactRolesByJobOrderContactRoleIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "jobOrderContactRoleId",
"in": "path",
"description": "The Id of the job order contact role to remove",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/JobOrders/{id}/copy": {
"post": {
"tags": [
"JobOrders"
],
"summary": "Copy an existing Job Order",
"description": "Copies an existing Job Order.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-write ````",
"operationId": "JobOrdersByIdCopyPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "This represents the source job order which needs to be copied.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.CopyJobOrderCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.CopyJobOrderCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.CopyJobOrderCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.CopyJobOrderCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.CopyJobOrderCommand.Result"
}
}
}
}
}
}
},
"/JobOrders/{id}/CustomData": {
"get": {
"tags": [
"JobOrders"
],
"summary": "Get Custom Data",
"description": "Gets a list of Custom Data Properties for a Job Order.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-read or order-write ````",
"operationId": "JobOrdersByIdCustomDataGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "includeInactiveProperties",
"in": "query",
"description": "When true, any properties that have been marked inactive will also be returned.",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.CustomData.EntityCustomDataQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.CustomData.EntityCustomDataQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.CustomData.EntityCustomDataQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.CustomData.EntityCustomDataQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.CustomData.EntityCustomDataQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.CustomData.EntityCustomDataQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.CustomData.EntityCustomDataQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"put": {
"tags": [
"JobOrders"
],
"summary": "Update Custom Data",
"description": "Updates the Custom Data Properties for a Job Order.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-write ````",
"operationId": "JobOrdersByIdCustomDataPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The list of values to store.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.CustomData.UpdateEntityCustomDataRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.CustomData.UpdateEntityCustomDataRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.CustomData.UpdateEntityCustomDataRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.CustomData.UpdateEntityCustomDataRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.CustomData.UpdateEntityCustomDataRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.CustomData.UpdateEntityCustomDataRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.CustomData.UpdateEntityCustomDataRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.CustomData.UpdateEntityCustomDataRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/JobOrders/{id}/directHireFinancials": {
"get": {
"tags": [
"JobOrders"
],
"summary": "Get Direct Hire Financial Details.",
"description": "Gets financial information about the job order of type 'Direct Hire'.\r\nThis endpoint would return 403 Forbidden if you attempt to get information about \r\na job order with type that is not 'Direct Hire'. \r\nIn order to determine a job order type you could use endpoint GET /jobOrders/{jobOrderId}.\r\nIn order to change a job order type you could use endpoint PATCH /jobOrders/{jobOrderId}.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-read or order-write ````",
"operationId": "JobOrdersByIdDirectHireFinancialsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderDirectHireFinancials.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderDirectHireFinancials.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderDirectHireFinancials.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderDirectHireFinancials.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderDirectHireFinancials.Result"
}
}
}
}
}
},
"put": {
"tags": [
"JobOrders"
],
"summary": "Update Job Order Direct Hire Financial Details",
"description": "Updates financial details needed for a job order with job order type 'Direct Hire'.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-write ````",
"operationId": "JobOrdersByIdDirectHireFinancialsPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The body of the request containing the updated financial details.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderDirectHireFinancialsRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderDirectHireFinancialsRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderDirectHireFinancialsRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderDirectHireFinancialsRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderDirectHireFinancialsRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderDirectHireFinancialsRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderDirectHireFinancialsRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderDirectHireFinancialsRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/JobOrders/{id}/documents": {
"get": {
"tags": [
"JobOrders"
],
"summary": "Get Documents",
"description": "Gets a list of documents linked to the job order.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-read or order-write ````",
"operationId": "JobOrdersByIdDocumentsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of documents to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of documents to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "sortByAscending",
"in": "query",
"description": "true to sort by ASC, defaults to DESC",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "sortBy",
"in": "query",
"description": "Field to sort by, valid fields are \"DocumentType\" and \"DocumentDate\"",
"style": "form",
"schema": {
"type": "string",
"default": "DocumentDate"
}
},
{
"name": "filterByDocumentTypeId",
"in": "query",
"description": "DocumentTypeId to filter by",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Documents.GetEntityDocumentsQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Documents.GetEntityDocumentsQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Documents.GetEntityDocumentsQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Documents.GetEntityDocumentsQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Documents.GetEntityDocumentsQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Documents.GetEntityDocumentsQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Documents.GetEntityDocumentsQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"JobOrders"
],
"summary": "Upload Document",
"description": "Uploads a document to the job order. This requires a multipart form-data POST request. \r\nOne part must contain the file to upload and subsequent parts will be used to provide \r\nother data such as documentTypeId.\r\n\r\nFor more information about using formdata, see: https://developer.mozilla.org/en-US/docs/Web/API/FormData/FormData\r\nFor more information about using multimart/form-data, see: http://stackoverflow.com/questions/4526273/what-does-enctype-multipart-form-data-mean\r\nBelow is an example multipart/form-data POST request body:\r\n\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn\r\nContent-Disposition: form-data; name=\"file\"; filename=\"Test.txt\"\r\nContent-Type: text/plain\r\n\r\nThis is where the file content is placed! This is a valid for a text document!\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn\r\nContent-Disposition: form-data; name=\"fileName\"\r\n\r\nNewFileName.txt\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn\r\nContent-Disposition: form-data; name=\"expirationDate\"\r\n\r\n2012-12-21\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn\r\nContent-Disposition: form-data; name=\"documentTypeId\"\r\n\r\n1\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn\r\nContent-Disposition: form-data; name=\"version\"\r\n\r\n1\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn\r\nContent-Disposition: form-data; name=\"description\"\r\n\r\ntest\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn--\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): order-write ````",
"operationId": "JobOrdersByIdDocumentsPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"201": {
"description": "Id of the new document",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
}
}
}
}
}
},
"/JobOrders/{id}/documents/{documentId}": {
"get": {
"tags": [
"JobOrders"
],
"summary": "Get Document Details",
"description": "Gets details about the specified document for the specified job order.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-read or order-write ````",
"operationId": "JobOrdersByIdDocumentsByDocumentIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "documentId",
"in": "path",
"description": "The Id of the document.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.GetEntityDocumentQuery.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.GetEntityDocumentQuery.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.GetEntityDocumentQuery.Document"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.GetEntityDocumentQuery.Document"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.GetEntityDocumentQuery.Document"
}
}
}
}
}
},
"put": {
"tags": [
"JobOrders"
],
"summary": "Update Document Details",
"description": "Updates detail information about the document.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-write ````",
"operationId": "JobOrdersByIdDocumentsByDocumentIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "documentId",
"in": "path",
"description": "The Id of the document.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The body of the request containing the updated details information.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Documents.UpdateEntityDocumentDetailsRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Documents.UpdateEntityDocumentDetailsRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Documents.UpdateEntityDocumentDetailsRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Documents.UpdateEntityDocumentDetailsRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Documents.UpdateEntityDocumentDetailsRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Documents.UpdateEntityDocumentDetailsRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Documents.UpdateEntityDocumentDetailsRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Documents.UpdateEntityDocumentDetailsRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
},
"delete": {
"tags": [
"JobOrders"
],
"summary": "Delete Document",
"description": "Deletes the specified document.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-write ````",
"operationId": "JobOrdersByIdDocumentsByDocumentIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "documentId",
"in": "path",
"description": "The Id of the document.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/JobOrders/{id}/documents/{documentId}/bytes": {
"get": {
"tags": [
"JobOrders"
],
"summary": "Get Document",
"description": "Gets the specified job order document.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-read or order-write ````",
"operationId": "JobOrdersByIdDocumentsByDocumentIdBytesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "documentId",
"in": "path",
"description": "The Id of the document.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "returnPdf",
"in": "query",
"description": "Used to indicated whether or not a PDF should be returned if the file is convertable to PDF",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "string",
"format": "byte"
}
},
"text/csv": {
"schema": {
"type": "string",
"format": "byte"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"type": "string",
"format": "byte"
}
},
"application/json": {
"schema": {
"type": "string",
"format": "byte"
}
},
"text/json": {
"schema": {
"type": "string",
"format": "byte"
}
},
"application/xml": {
"schema": {
"type": "string",
"format": "byte"
}
},
"text/xml": {
"schema": {
"type": "string",
"format": "byte"
}
}
}
}
}
}
},
"/JobOrders/{id}/documents/metadata": {
"get": {
"tags": [
"JobOrders"
],
"summary": "Get Documents Metadata",
"description": "Returns information about document creation restrictions.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-read or order-write ````",
"operationId": "JobOrdersByIdDocumentsMetadataGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.DocumentMetadataQuery.Query"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.DocumentMetadataQuery.Query"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.DocumentMetadataQuery.Query"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.DocumentMetadataQuery.Query"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.DocumentMetadataQuery.Query"
}
}
}
}
}
}
},
"/JobOrders/{id}/extendedDetails": {
"get": {
"tags": [
"JobOrders"
],
"summary": "Get Extended Details",
"description": "Gets additional details about the job order.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-read or order-write ````",
"operationId": "JobOrdersByIdExtendedDetailsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderExtendedDetailsQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderExtendedDetailsQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderExtendedDetailsQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderExtendedDetailsQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderExtendedDetailsQuery.Result"
}
}
}
}
}
}
},
"/JobOrders/{id}/Financials": {
"get": {
"tags": [
"JobOrders"
],
"summary": "Get Financial Details",
"description": "Gets financial details about the job order.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-read or order-write ````",
"operationId": "JobOrdersByIdFinancialsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderFinancialDetailsQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderFinancialDetailsQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderFinancialDetailsQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderFinancialDetailsQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderFinancialDetailsQuery.Result"
}
}
}
}
}
},
"put": {
"tags": [
"JobOrders"
],
"summary": "Update Financial Details",
"description": "Updates financial details about the job order.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-read or order-write ````",
"operationId": "JobOrdersByIdFinancialsPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The body of the request containing the updated financial details.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderFinancialsRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderFinancialsRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderFinancialsRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderFinancialsRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderFinancialsRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderFinancialsRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderFinancialsRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderFinancialsRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/JobOrders/{id}/interestCodes": {
"get": {
"tags": [
"JobOrders"
],
"summary": "Get Job Order Interest Codes",
"description": "Returns a paged list of job order interest codes ordered by the InterestCode column.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-read or order-write ````",
"operationId": "JobOrdersByIdInterestCodesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of interest codes to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of interest codes to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.InterestCodes.JobOrderInterestCodesQuery.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.InterestCodes.JobOrderInterestCodesQuery.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.InterestCodes.JobOrderInterestCodesQuery.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.InterestCodes.JobOrderInterestCodesQuery.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.InterestCodes.JobOrderInterestCodesQuery.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.InterestCodes.JobOrderInterestCodesQuery.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.InterestCodes.JobOrderInterestCodesQuery.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"JobOrders"
],
"summary": "Create Job Order Interest Code",
"description": "Creates a job order interest code.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-write ````",
"operationId": "JobOrdersByIdInterestCodesPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The request body containing the job order interest code to create.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderInterestCodeRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderInterestCodeRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderInterestCodeRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderInterestCodeRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderInterestCodeRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderInterestCodeRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderInterestCodeRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderInterestCodeRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.InterestCodes.CreateJobOrderInterestCodeCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.InterestCodes.CreateJobOrderInterestCodeCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.InterestCodes.CreateJobOrderInterestCodeCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.InterestCodes.CreateJobOrderInterestCodeCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.InterestCodes.CreateJobOrderInterestCodeCommand.Result"
}
}
}
}
}
},
"put": {
"tags": [
"JobOrders"
],
"summary": "Update Job Order Interest Codes",
"description": "Updates a job order's interest codes.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-write ````",
"operationId": "JobOrdersByIdInterestCodesPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the Job Order",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The request body containing an updated list of the job order's interest codes",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderInterestCodesRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderInterestCodesRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderInterestCodesRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderInterestCodesRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderInterestCodesRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderInterestCodesRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderInterestCodesRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderInterestCodesRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/JobOrders/{id}/interestCodes/{jobOrderInterestCodeId}": {
"get": {
"tags": [
"JobOrders"
],
"summary": "Get Job Order Interest Code",
"description": "Gets the specified job order interest code.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-read or order-write ````",
"operationId": "JobOrdersByIdInterestCodesByJobOrderInterestCodeIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "jobOrderInterestCodeId",
"in": "path",
"description": "The Id of the job order interest code.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.InterestCodes.JobOrderInterestCodesQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.InterestCodes.JobOrderInterestCodesQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.InterestCodes.JobOrderInterestCodesQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.InterestCodes.JobOrderInterestCodesQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.InterestCodes.JobOrderInterestCodesQuery.Result"
}
}
}
}
}
},
"delete": {
"tags": [
"JobOrders"
],
"summary": "Delete Job Order Interest Code",
"description": "Deletes a job order interest code.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-write ````",
"operationId": "JobOrdersByIdInterestCodesByJobOrderInterestCodeIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "jobOrderInterestCodeId",
"in": "path",
"description": "The Id of the job order interest code to delete.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
},
"put": {
"tags": [
"JobOrders"
],
"summary": "Update Job Order Interest Code",
"description": "Updates a job order interest code. Note that updates on the InterestCodeId will set the date created to today.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-write ````",
"operationId": "JobOrdersByIdInterestCodesByJobOrderInterestCodeIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "jobOrderInterestCodeId",
"in": "path",
"description": "The Id of the job order interest code.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The request body containing the job order interest code to update.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderInterestCodeRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderInterestCodeRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderInterestCodeRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderInterestCodeRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderInterestCodeRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderInterestCodeRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderInterestCodeRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderInterestCodeRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/JobOrders/{id}/jobBoardCandidate": {
"post": {
"tags": [
"JobOrders"
],
"summary": "Create Job Board Candidate",
"description": "Makes the specified Employee a Candidate for the Job Order.\n \n```` Allows roles: Service, ServiceRep, WebUserEmployee ````\n \n```` Requires scope(s): jobboard-write ````",
"operationId": "JobOrdersByIdJobBoardCandidatePost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The body of the request containing the Id of the employee to add as a candidate",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateJobOrderJobBoardCandidate"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateJobOrderJobBoardCandidate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateJobOrderJobBoardCandidate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateJobOrderJobBoardCandidate"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateJobOrderJobBoardCandidate"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateJobOrderJobBoardCandidate"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateJobOrderJobBoardCandidate"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateJobOrderJobBoardCandidate"
}
}
}
},
"responses": {
"201": {
"description": "The specified employee was added as a candidate and the Id of the candidate is returned.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.CreateJobOrderJobBoardCandidateCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.CreateJobOrderJobBoardCandidateCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.CreateJobOrderJobBoardCandidateCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.CreateJobOrderJobBoardCandidateCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.CreateJobOrderJobBoardCandidateCommand.Result"
}
}
}
}
}
}
},
"/JobOrders/{id}/jobBoardCandidateFromResume": {
"post": {
"tags": [
"JobOrders"
],
"summary": "Create Job Board Candidate From Resume",
"description": "Converts the provided resume into an employee and then adds them as a Candidate for the Job Order.\r\n\r\nAccepted request header values:\r\nBranchId - An optional override BranchID to create the employee record in.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): jobboard-write ````",
"operationId": "JobOrdersByIdJobBoardCandidateFromResumePost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"201": {
"description": "The specified employee was added as a candidate and the Id of the candidate is returned.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.CreateJobOrderJobBoardCandidateFromResumeCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.CreateJobOrderJobBoardCandidateFromResumeCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.CreateJobOrderJobBoardCandidateFromResumeCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.CreateJobOrderJobBoardCandidateFromResumeCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.CreateJobOrderJobBoardCandidateFromResumeCommand.Result"
}
}
}
},
"520": {
"description": "The resume parsing service is encountering server issues. Try again later."
}
}
}
},
"/JobOrders/{id}/jobBoardDetails": {
"get": {
"tags": [
"JobOrders"
],
"summary": "Get Job Board details",
"description": "Gets the job order details in accordance with the Job Board settings.\n \n```` Allows roles: ServiceRep, WebUserEmployee, Service ````\n \n```` Requires scope(s): jobboard-read or jobboard-write ````",
"operationId": "JobOrdersByIdJobBoardDetailsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "culture",
"in": "query",
"description": "Optional parameter to pull locale specific job order details. If a translation does not exist, then the system will fallback to the system default locale.",
"style": "form",
"schema": {
"maxLength": 20,
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderJobBoardDetails.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderJobBoardDetails.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderJobBoardDetails.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderJobBoardDetails.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderJobBoardDetails.Result"
}
}
}
}
}
}
},
"/JobOrders/{id}/jobBoardOptions": {
"put": {
"tags": [
"JobOrders"
],
"summary": "Inserts/Updates Job Order Job Board Options",
"description": "Updates the Job Board options for a job order.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-write ````",
"operationId": "JobOrdersByIdJobBoardOptionsPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The body of the request containing the information required to update the options.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderJobBoardOptionsRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderJobBoardOptionsRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderJobBoardOptionsRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderJobBoardOptionsRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderJobBoardOptionsRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderJobBoardOptionsRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderJobBoardOptionsRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderJobBoardOptionsRequest"
}
}
}
},
"responses": {
"204": {
"description": ""
}
}
}
},
"/JobOrders/{id}/MatchingRateSheets": {
"get": {
"tags": [
"JobOrders"
],
"summary": "Gets a list of rate sheets that are applicable to this job order,\r\nconsidering its CustomerId, WorksiteId, JobTitleId, BranchId, and ShiftId.",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-read or order-write ````",
"operationId": "JobOrdersByIdMatchingRateSheetsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "JobTitleIdOverride",
"in": "query",
"description": "If provided, returned Rate Sheets will be matched against this JobTitleIdOverride\r\ninstead of the JobTitleId on the Job Order.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "DoNotMatchOnJobTitleId",
"in": "query",
"description": "If provided, will set the JobTitleIdOverride to a value that doesn't exist in the database",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "WorksiteIdOverride",
"in": "query",
"description": "If provided, returned Rate Sheets will be matched against this WorksiteIdOverride\r\ninstead of the WorksiteId on the Job Order.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "DoNotMatchOnWorksiteId",
"in": "query",
"description": "If provided, will set the WorksiteIdOverride to a value that doesn't exist in the database",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "ShiftIdOverride",
"in": "query",
"description": "If provided, returned Rate Sheets will be matched against this ShiftIdOverride\r\ninstead of the ShiftId on the Job Order.",
"style": "form",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "DoNotMatchOnShiftId",
"in": "query",
"description": "If provided, will set the ShiftIdOverride to a value that doesn't exist in the database",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "BranchIdOverride",
"in": "query",
"description": "If provided, returned Rate Sheets will be matched against this BranchIdOverride\r\ninstead of the BranchId on the Job Order.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "DoNotMatchOnBranchId",
"in": "query",
"description": "If provided, will set the BranchIdOverride to a value that doesn't exist in the database",
"style": "form",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderMatchingRateSheets.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderMatchingRateSheets.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderMatchingRateSheets.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderMatchingRateSheets.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderMatchingRateSheets.Result"
}
}
}
}
}
}
},
"/JobOrders/{id}/messages": {
"get": {
"tags": [
"JobOrders"
],
"summary": "Get Messages",
"description": "Gets a list of messages linked to the job order.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-read or order-write ````",
"operationId": "JobOrdersByIdMessagesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of messages to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of messages to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "messageActionId",
"in": "query",
"description": "Optional filter on the Id of the message action. Valid values can be found in the Message Action List. ref: /datalists/messageactions",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "messageActionTypeId",
"in": "query",
"description": "Optional filter on the Id of the message action type. Valid values can be found in the Message Action Type List. ref: /datalists/messageactiontypes",
"style": "form",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "authorSrIdent",
"in": "query",
"description": "Optional filter on the Id of the service rep who created the message.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "startDate",
"in": "query",
"description": "Optional filter on the date of the message. Any messages created on or after the date supplied will be returned.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "endDate",
"in": "query",
"description": "Optional filter on the date of the message. Any messages created on or before the date supplied will be returned.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "orderBy",
"in": "query",
"description": "Optional parameter to specify the column to order by. Valid values are 'date', 'action', 'actiondescription','authorsrident','author','id', and 'message', Defaults to 'date'",
"style": "form",
"schema": {
"maxLength": 150,
"minLength": 0,
"type": "string"
}
},
{
"name": "orderByAscending",
"in": "query",
"description": "Optional parameter to specify the direction to order by. Specify true to order ascending.",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "messageText",
"in": "query",
"description": "Optional parameter to search on the message text. To search for any message which contains a word which starts with accep, the value would be: accep*",
"style": "form",
"schema": {
"maxLength": 1000,
"minLength": 0,
"type": "string"
}
},
{
"name": "limitToPrimaryMessages",
"in": "query",
"description": "Set to true to only return the primary messages. Currently only one primary message is supported. \r\n This can be set using the endpoint PATCH joborders/{id} and setting the value PrimaryMessageId.\r\n Optional filters such as start date and end date are ignored when this value is true.",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"JobOrders"
],
"summary": "Create Message",
"description": "Creates a message and links it to the job order.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-read or order-write ````",
"operationId": "JobOrdersByIdMessagesPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The body of the request containing the information required to create the message.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateMessageWithLinkedDocumentsRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateMessageWithLinkedDocumentsRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateMessageWithLinkedDocumentsRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateMessageWithLinkedDocumentsRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateMessageWithLinkedDocumentsRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateMessageWithLinkedDocumentsRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateMessageWithLinkedDocumentsRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateMessageWithLinkedDocumentsRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
}
}
}
}
}
},
"/JobOrders/{id}/messages/{messageId}": {
"get": {
"tags": [
"JobOrders"
],
"summary": "Gets the details of a specific message.",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-read or order-write ````",
"operationId": "JobOrdersByIdMessagesByMessageIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "messageId",
"in": "path",
"description": "The Id of the message.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageDetails"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageDetails"
}
}
}
}
}
}
},
"/JobOrders/{id}/messages/relatedEntities": {
"get": {
"tags": [
"JobOrders"
],
"summary": "Gets the specified job order's related entities.",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-read or order-write ````",
"operationId": "JobOrdersByIdMessagesRelatedEntitiesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the job order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageLink"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageLink"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageLink"
}
}
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageLink"
}
}
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageLink"
}
}
}
}
}
}
}
},
"/JobOrders/{id}/offers": {
"post": {
"tags": [
"JobOrders"
],
"summary": "Create Job Order Offer",
"description": "Makes an employee an offer for a job order in Buzz. Before an employee can be made an offer, they must be vetted\r\nby an assignment restriction session and have no results or all of the results approved and also be set up as a\r\nweb user for Buzz. This can be checked from the Employees/{id}/webUser endpoint based on if there is a \r\nproduct instance for companion.\r\nAn assignment restriction session can be started at the jobOrder/{orderId}/assignmentRestriction endpoint.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): ordercandidate-write ````",
"operationId": "JobOrdersByIdOffersPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Id of the job order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "A model containing the information with which to create the new job order candidate",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderOfferRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderOfferRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderOfferRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderOfferRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderOfferRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderOfferRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderOfferRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderOfferRequest"
}
}
}
},
"responses": {
"201": {
"description": "Id of the new job order candidate",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.CreateJobOrderOfferCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.CreateJobOrderOfferCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.CreateJobOrderOfferCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.CreateJobOrderOfferCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.CreateJobOrderOfferCommand.Result"
}
}
}
},
"403": {
"description": "The employee does not have a web user account linked to a Buzz product instance."
},
"409": {
"description": "The employee has already been made an offer for this job order."
}
}
}
},
"/JobOrders/{id}/positionSummary": {
"get": {
"tags": [
"JobOrders"
],
"summary": "Get Job Order Position Summary",
"description": "Gets Position Summary information for the specified Job Order if it exists.\r\nReturns a NoContent if no such information is available.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-read or order-write ````",
"operationId": "JobOrdersByIdPositionSummaryGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderPositionSummary.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderPositionSummary.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderPositionSummary.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderPositionSummary.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderPositionSummary.Result"
}
}
}
},
"204": {
"description": "No Content"
}
}
},
"put": {
"tags": [
"JobOrders"
],
"summary": "Update Job Order Position Summary",
"description": "Updates Position Summary information for the specified Job Order.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): jobboard-write ````",
"operationId": "JobOrdersByIdPositionSummaryPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "A request containing data needed to update the job order position summary information.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpsertJobOrderPositionSummaryRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpsertJobOrderPositionSummaryRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpsertJobOrderPositionSummaryRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpsertJobOrderPositionSummaryRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpsertJobOrderPositionSummaryRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpsertJobOrderPositionSummaryRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpsertJobOrderPositionSummaryRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpsertJobOrderPositionSummaryRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/JobOrders/{id}/requiredDocumentTypes": {
"get": {
"tags": [
"JobOrders"
],
"summary": "Get Required Document Types for Order",
"description": "Returns a list of required document types for a job order\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-read or order-write ````",
"operationId": "JobOrdersByIdRequiredDocumentTypesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.JobOrderRequiredDocumentTypes.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.JobOrderRequiredDocumentTypes.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.JobOrderRequiredDocumentTypes.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.JobOrderRequiredDocumentTypes.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.JobOrderRequiredDocumentTypes.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.JobOrderRequiredDocumentTypes.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.JobOrderRequiredDocumentTypes.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"JobOrders"
],
"summary": "Create Job Order Required Document Type",
"description": "Creates a required document type for the specified job order.\r\nNot exposing most of the properties here - inserting default values for them in the stored procedure instead.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-write ````",
"operationId": "JobOrdersByIdRequiredDocumentTypesPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The request body containing the required document type id.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderRequiredDocumentTypeRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderRequiredDocumentTypeRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderRequiredDocumentTypeRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderRequiredDocumentTypeRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderRequiredDocumentTypeRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderRequiredDocumentTypeRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderRequiredDocumentTypeRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.CreateJobOrderRequiredDocumentTypeRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.CreateJobOrderRequiredDocumentType.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.CreateJobOrderRequiredDocumentType.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.CreateJobOrderRequiredDocumentType.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.CreateJobOrderRequiredDocumentType.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.CreateJobOrderRequiredDocumentType.Result"
}
}
}
}
}
}
},
"/JobOrders/{id}/requiredDocumentTypes/{jobOrderRequiredDocumentTypeId}": {
"put": {
"tags": [
"JobOrders"
],
"summary": "Update Job Order Required Document Type",
"description": "Updates a required document type for the specified job order.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-write ````",
"operationId": "JobOrdersByIdRequiredDocumentTypesByJobOrderRequiredDocumentTypeIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "jobOrderRequiredDocumentTypeId",
"in": "path",
"description": "The Id of the job order required document.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The request body containing the notes and required flag.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderRequiredDocumentTypeRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderRequiredDocumentTypeRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderRequiredDocumentTypeRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderRequiredDocumentTypeRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderRequiredDocumentTypeRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderRequiredDocumentTypeRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderRequiredDocumentTypeRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderRequiredDocumentTypeRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
},
"delete": {
"tags": [
"JobOrders"
],
"summary": "Delete Required Document Type of an Order",
"description": "Deletes a required document type associated with an order.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-write ````",
"operationId": "JobOrdersByIdRequiredDocumentTypesByJobOrderRequiredDocumentTypeIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "jobOrderRequiredDocumentTypeId",
"in": "path",
"description": "The id of the order required document type.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/JobOrders/{id}/Schedule": {
"get": {
"tags": [
"JobOrders"
],
"summary": "Get Schedule Details",
"description": "Gets scheduling details about the job order.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-read or order-write ````",
"operationId": "JobOrdersByIdScheduleGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderScheduleQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderScheduleQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderScheduleQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderScheduleQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderScheduleQuery.Result"
}
}
}
}
}
}
},
"/JobOrders/{id}/Status": {
"post": {
"tags": [
"JobOrders"
],
"summary": "Update Job Order Status",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-write ````",
"operationId": "JobOrdersByIdStatusPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The details of the status change.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.StatusChange.StatusChangeApiRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.StatusChange.StatusChangeApiRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.StatusChange.StatusChangeApiRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.StatusChange.StatusChangeApiRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.StatusChange.StatusChangeApiRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.StatusChange.StatusChangeApiRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.StatusChange.StatusChangeApiRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.StatusChange.StatusChangeApiRequest"
}
}
}
},
"responses": {
"200": {
"description": "Status Changed",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderStatusUpdateCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderStatusUpdateCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderStatusUpdateCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderStatusUpdateCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderStatusUpdateCommand.Result"
}
}
}
},
"202": {
"description": "Status Changed and Additional Actions are staged for execution or had errors that require additional attention.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderStatusUpdateCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderStatusUpdateCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderStatusUpdateCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderStatusUpdateCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderStatusUpdateCommand.Result"
}
}
}
},
"400": {
"description": "Bad Request"
}
}
}
},
"/JobOrders/{id}/Status/{newJobOrderStatusId}/metadata": {
"get": {
"tags": [
"JobOrders"
],
"summary": "Get Job Order Status Change Metadata",
"description": "Returns the metadata regarding the status change for a Job Order. \r\n This includes information regarding the additional actions, validation, and the current state of the prerequisites for the status change.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-read or order-write ````",
"operationId": "JobOrdersByIdStatusByNewJobOrderStatusIdMetadataGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "newJobOrderStatusId",
"in": "path",
"description": "The Id of the new job order status.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "returnAllPrerequisites",
"in": "query",
"description": "When true, all dynamic validation results are returned regardless of error or not. \r\n When false, only the prerequisites that have had errors are returned. Defaults to false.",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "returnAllAdditionalActions",
"in": "query",
"description": "When true, both required and optional additional actions are returned. \r\n When false, only additional actions that are optional are returned. Defaults to true.",
"style": "form",
"schema": {
"type": "boolean",
"default": true
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.StatusChange.OriginStatusChangeMetadataQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.StatusChange.OriginStatusChangeMetadataQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.StatusChange.OriginStatusChangeMetadataQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.StatusChange.OriginStatusChangeMetadataQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.StatusChange.OriginStatusChangeMetadataQuery.Result"
}
}
}
}
}
}
},
"/JobOrders/{id}/Summary": {
"get": {
"tags": [
"JobOrders"
],
"summary": "Get Summary",
"description": "Gets a basic summary of the specified job order.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-read or order-write ````",
"operationId": "JobOrdersByIdSummaryGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderSummaryQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderSummaryQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderSummaryQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderSummaryQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderSummaryQuery.Result"
}
}
}
}
}
}
},
"/JobOrders/{id}/tasks": {
"get": {
"tags": [
"JobOrders"
],
"summary": "Get Job Order Tasks",
"description": "Returns the list of tasks linked to the job order and belonging to the current user.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): (order-read or order-write) and (task-read or task-write) ````",
"operationId": "JobOrdersByIdTasksGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "TaskQueryType",
"in": "query",
"required": true,
"style": "form",
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Enums.TaskQueryTypes"
}
},
{
"name": "Skip",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Take",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "StartDueDate",
"in": "query",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "EndDueDate",
"in": "query",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "Priority",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "IncludeNullDueDates",
"in": "query",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "FilterText",
"in": "query",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "AssignedToServiceRepId",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "TeamId",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "CreatedByServiceRepId",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "IsPinned",
"in": "query",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "StartDateArchived",
"in": "query",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "EndDateArchived",
"in": "query",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "OrderBy",
"in": "query",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "OrderByAscending",
"in": "query",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "Tags",
"in": "query",
"style": "form",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Tasks.TaskListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Tasks.TaskListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Tasks.TaskListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Tasks.TaskListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Tasks.TaskListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Tasks.TaskListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Tasks.TaskListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"JobOrders"
],
"summary": "Create Job Order Task",
"description": "Creates a task and links it to the job order.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-write and task-write ````",
"operationId": "JobOrdersByIdTasksPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The body of the request containing the information required to create the task.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateEntityTaskRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateEntityTaskRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateEntityTaskRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateEntityTaskRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateEntityTaskRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateEntityTaskRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateEntityTaskRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateEntityTaskRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.CreateTaskCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.CreateTaskCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.CreateTaskCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.CreateTaskCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.CreateTaskCommand.Result"
}
}
}
}
}
}
},
"/JobOrders/{id}/tasks/{taskId}": {
"get": {
"tags": [
"JobOrders"
],
"summary": "Get Job Order Task Details",
"description": "Gets more detailed information about a task pertaining to the job order.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): (order-read or order-write) and (task-read or task-write) ````",
"operationId": "JobOrdersByIdTasksByTaskIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.TaskDetailsQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.TaskDetailsQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.TaskDetailsQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.TaskDetailsQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.TaskDetailsQuery.Result"
}
}
}
}
}
},
"put": {
"tags": [
"JobOrders"
],
"summary": "Update Job Order Task",
"description": "Updates a task linked to the job order.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-write and task-write ````",
"operationId": "JobOrdersByIdTasksByTaskIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The body of the request containing the updated task details.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.UpdateTaskRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.UpdateTaskRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.UpdateTaskRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.UpdateTaskRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.UpdateTaskRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.UpdateTaskRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.UpdateTaskRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.UpdateTaskRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/JobOrders/{id}/tasks/{taskId}/archive": {
"put": {
"tags": [
"JobOrders"
],
"summary": "Archive Job Order Task",
"description": "Archives the task linked to the job order.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): order-write and task-write ````",
"operationId": "JobOrdersByIdTasksByTaskIdArchivePut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/JobOrders/{id}/tasks/{taskId}/assign": {
"put": {
"tags": [
"JobOrders"
],
"summary": "Assign Job Order Task",
"description": "Assigns the task linked to the job order.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): task-write ````",
"operationId": "JobOrdersByIdTasksByTaskIdAssignPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The body of the request containing the new assignment details for the task.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/JobOrders/{id}/tasks/{taskId}/messages": {
"get": {
"tags": [
"JobOrders"
],
"summary": "Get Job Order Task Messages List",
"description": "Returns the list of messages linked to the task.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): task-read or task-write ````",
"operationId": "JobOrdersByIdTasksByTaskIdMessagesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"JobOrders"
],
"summary": "Create Job Order Task Message",
"description": "Creates a message and links it to the Task as well as any related Entities.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): task-read or task-write ````",
"operationId": "JobOrdersByIdTasksByTaskIdMessagesPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The body of the message containing the new message details.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
}
}
}
}
}
},
"/JobOrders/{id}/tasks/{taskId}/messages/{messageId}": {
"get": {
"tags": [
"JobOrders"
],
"summary": "Get Job Order Task Message Details",
"description": "Returns details about the message.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): task-read or task-write ````",
"operationId": "JobOrdersByIdTasksByTaskIdMessagesByMessageIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "messageId",
"in": "path",
"description": "The Id of the message.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageSummary"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageSummary"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageSummary"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageSummary"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageSummary"
}
}
}
}
}
}
},
"/JobOrders/{id}/tasks/{taskId}/pin": {
"put": {
"tags": [
"JobOrders"
],
"summary": "Pin Job Order Task",
"description": "Pins the task linked to the job order.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): order-write and task-write ````",
"operationId": "JobOrdersByIdTasksByTaskIdPinPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/JobOrders/{id}/tasks/{taskId}/unarchive": {
"put": {
"tags": [
"JobOrders"
],
"summary": "Unarchive Job Order Task",
"description": "Unarchives the task linked to the job order.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): order-write and task-write ````",
"operationId": "JobOrdersByIdTasksByTaskIdUnarchivePut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/JobOrders/{id}/tasks/{taskId}/unpin": {
"put": {
"tags": [
"JobOrders"
],
"summary": "Unpin Job Order Task",
"description": "Unpins the task linked to the job order.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): order-write and task-write ````",
"operationId": "JobOrdersByIdTasksByTaskIdUnpinPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/JobOrders/{id}/Vendors": {
"get": {
"tags": [
"JobOrders"
],
"summary": "Get Vendors assigned to JobOrder",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-read or order-write ````",
"operationId": "JobOrdersByIdVendorsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "JobOrder Id.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "Amount of list items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "Amount of list items to take. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.Vendors.JobOrderVendorsList.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.Vendors.JobOrderVendorsList.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.Vendors.JobOrderVendorsList.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.Vendors.JobOrderVendorsList.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.Vendors.JobOrderVendorsList.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.Vendors.JobOrderVendorsList.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.Vendors.JobOrderVendorsList.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"JobOrders"
],
"summary": "Assign Vendor to JobOrder",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-write ````",
"operationId": "JobOrdersByIdVendorsPost",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.JobOrderVendorRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.JobOrderVendorRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.JobOrderVendorRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.JobOrderVendorRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.JobOrderVendorRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.JobOrderVendorRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.JobOrderVendorRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.JobOrderVendorRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.Vendors.JobOrderVendorsCreate.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.Vendors.JobOrderVendorsCreate.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.Vendors.JobOrderVendorsCreate.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.Vendors.JobOrderVendorsCreate.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.Vendors.JobOrderVendorsCreate.Result"
}
}
}
}
}
}
},
"/JobOrders/{id}/Vendors/{jobOrderVendorId}": {
"get": {
"tags": [
"JobOrders"
],
"summary": "Get Vendor assigned to JobOrder",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-read or order-write ````",
"operationId": "JobOrdersByIdVendorsByJobOrderVendorIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "JobOrder Id.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "jobOrderVendorId",
"in": "path",
"description": "JobOrder Vendor Id.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.Vendors.JobOrderVendorsList.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.Vendors.JobOrderVendorsList.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.Vendors.JobOrderVendorsList.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.Vendors.JobOrderVendorsList.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.Vendors.JobOrderVendorsList.Result"
}
}
}
}
}
},
"put": {
"tags": [
"JobOrders"
],
"summary": "Edit a Vendor already assigned to JobOrder",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-write ````",
"operationId": "JobOrdersByIdVendorsByJobOrderVendorIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "jobOrderVendorId",
"in": "path",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.JobOrderVendorRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.JobOrderVendorRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.JobOrderVendorRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.JobOrderVendorRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.JobOrderVendorRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.JobOrderVendorRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.JobOrderVendorRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.JobOrderVendorRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
},
"delete": {
"tags": [
"JobOrders"
],
"summary": "Remove Vendor from JobOrder",
"description": "\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-write ````",
"operationId": "JobOrdersByIdVendorsByJobOrderVendorIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "jobOrderVendorId",
"in": "path",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/JobOrders/{id}/Worksite": {
"get": {
"tags": [
"JobOrders"
],
"summary": "Get Worksite",
"description": "Gets details about the job order's worksite.\n \n```` Allows roles: ServiceRep, WebUserEmployee, Service ````\n \n```` Requires scope(s): order-read or order-write ````",
"operationId": "JobOrdersByIdWorksiteGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the job order",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "culture",
"in": "query",
"description": "Optional parameter to pull localized texts.",
"style": "form",
"schema": {
"maxLength": 20,
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderWorksiteDetailsQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderWorksiteDetailsQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderWorksiteDetailsQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderWorksiteDetailsQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderWorksiteDetailsQuery.Result"
}
}
}
}
}
}
},
"/JobOrders/{JobOrderId}/candidates": {
"put": {
"tags": [
"JobOrders"
],
"summary": "Updates Multiple Candidates",
"description": "Accepts multiple candidates to update.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): ordercandidate-read or ordercandidate-write ````",
"operationId": "JobOrdersByJobOrderIdCandidatesPut",
"parameters": [
{
"name": "JobOrderId",
"in": "path",
"description": "Id of the job order",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The model containing the data to update candidates",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderCandidatesRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderCandidatesRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderCandidatesRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderCandidatesRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderCandidatesRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderCandidatesRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderCandidatesRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.UpdateJobOrderCandidatesRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/JobOrders/{jobOrderId}/candidates/{jobOrderCandidateId}/sendJobApplicationReceipt": {
"post": {
"tags": [
"JobOrders"
],
"summary": "Send a job application receipt email indicating that this candidate has applied to this job.",
"description": "Sends a job application receipt email to this candidate.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): ordercandidate-write ````",
"operationId": "JobOrdersByJobOrderIdCandidatesByJobOrderCandidateIdSendJobApplicationReceiptPost",
"parameters": [
{
"name": "jobOrderId",
"in": "path",
"description": "Id of the job order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "jobOrderCandidateId",
"in": "path",
"description": "Id of the job order candidate.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/JobOrders/{jobOrderId}/messages/{messageId}": {
"put": {
"tags": [
"JobOrders"
],
"summary": "Update Message",
"description": "Updates a message and links it to the job order.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-read or order-write ````",
"operationId": "JobOrdersByJobOrderIdMessagesByMessageIdPut",
"parameters": [
{
"name": "jobOrderId",
"in": "path",
"description": "The Id of the job order",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "messageId",
"in": "path",
"description": "The Id of the message",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The body of the request containing the information required to update the message.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.UpdateMessageWithLinkedDocumentsRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.UpdateMessageWithLinkedDocumentsRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.UpdateMessageWithLinkedDocumentsRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.UpdateMessageWithLinkedDocumentsRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.UpdateMessageWithLinkedDocumentsRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.UpdateMessageWithLinkedDocumentsRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.UpdateMessageWithLinkedDocumentsRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.UpdateMessageWithLinkedDocumentsRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.UpdateContactMessageResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.UpdateContactMessageResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.UpdateContactMessageResult"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.UpdateContactMessageResult"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.UpdateContactMessageResult"
}
}
}
}
}
}
},
"/JobOrders/{jobOrderId}/messages/{messageId}/documents": {
"post": {
"tags": [
"JobOrders"
],
"summary": "Upload document to a message",
"description": "\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): order-write ````",
"operationId": "JobOrdersByJobOrderIdMessagesByMessageIdDocumentsPost",
"parameters": [
{
"name": "jobOrderId",
"in": "path",
"description": "The Id of the job order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "messageId",
"in": "path",
"description": "The Id of the message.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"required": [
"DocumentName",
"DocumentTypeId"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
},
"DocumentName": {
"type": "string"
},
"DocumentTypeId": {
"type": "integer",
"format": "int32"
},
"Description": {
"maxLength": 255,
"type": "string"
},
"ExpirationDate": {
"type": "string",
"format": "date-time"
},
"Version": {
"type": "string"
}
}
},
"encoding": {
"File": {
"style": "form"
},
"DocumentName": {
"style": "form"
},
"DocumentTypeId": {
"style": "form"
},
"Description": {
"style": "form"
},
"ExpirationDate": {
"style": "form"
},
"Version": {
"style": "form"
}
}
}
}
},
"responses": {
"201": {
"description": "Id of the new document.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
}
}
}
}
}
},
"/JobOrders/financials/massupdate/datalists/multiplierCodes": {
"post": {
"tags": [
"JobOrders"
],
"summary": "Get Available Multiplier Codes",
"description": "Returns a list of multiplier codes available based upon the list of assignments and job orders for use during the mass update financials process.\r\nThe list is the intersection of all multiplier codes available for all customers of the orders and assignments.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-write ````",
"operationId": "JobOrdersFinancialsMassupdateDatalistsMultiplierCodesPost",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"requestBody": {
"description": "The criteria used to define which multiplier codes to return.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.AvailableMultiplierCodesCriteria"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.AvailableMultiplierCodesCriteria"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.AvailableMultiplierCodesCriteria"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.AvailableMultiplierCodesCriteria"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.AvailableMultiplierCodesCriteria"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.AvailableMultiplierCodesCriteria"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.AvailableMultiplierCodesCriteria"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.AvailableMultiplierCodesCriteria"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.MassUpdateFinancials.MassUpdateJobOrderFinancialsMultiplierCodes.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.MassUpdateFinancials.MassUpdateJobOrderFinancialsMultiplierCodes.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.MassUpdateFinancials.MassUpdateJobOrderFinancialsMultiplierCodes.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.MassUpdateFinancials.MassUpdateJobOrderFinancialsMultiplierCodes.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.MassUpdateFinancials.MassUpdateJobOrderFinancialsMultiplierCodes.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.MassUpdateFinancials.MassUpdateJobOrderFinancialsMultiplierCodes.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.MassUpdateFinancials.MassUpdateJobOrderFinancialsMultiplierCodes.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/JobOrders/financials/massupdate/sessions": {
"post": {
"tags": [
"JobOrders"
],
"summary": "Create Mass Update Financials Session",
"description": "Starts a job to update the financial details on all job orders and assignments provided. \r\nClients may opt to update a list of Job Orders, Assignments, or both.\r\nThis action is deferred and will return a SessionId to be used in following calls:\r\nGet results of calculation and review - /financials/massupdate/sessions/{sessionId}/results\r\nApply calculation to orders and assignments - /financials/massupdate/sessions/{sessionId}/commit\r\nGet status of session - /financials/massupdate/sessions/{sessionId}/status\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-write ````",
"operationId": "JobOrdersFinancialsMassupdateSessionsPost",
"requestBody": {
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.StageMassUpdateJobOrderFinancialsRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.StageMassUpdateJobOrderFinancialsRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.StageMassUpdateJobOrderFinancialsRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.StageMassUpdateJobOrderFinancialsRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.StageMassUpdateJobOrderFinancialsRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.StageMassUpdateJobOrderFinancialsRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.StageMassUpdateJobOrderFinancialsRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.StageMassUpdateJobOrderFinancialsRequest"
}
}
}
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.MassUpdateFinancials.StageMassUpdateFinancialsCalculation.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.MassUpdateFinancials.StageMassUpdateFinancialsCalculation.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.MassUpdateFinancials.StageMassUpdateFinancialsCalculation.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.MassUpdateFinancials.StageMassUpdateFinancialsCalculation.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.MassUpdateFinancials.StageMassUpdateFinancialsCalculation.Result"
}
}
}
}
}
}
},
"/JobOrders/financials/massupdate/sessions/{sessionId}/cancel": {
"post": {
"tags": [
"JobOrders"
],
"summary": "Cancel Mass Update Financials Session",
"description": "Cancels a mass update financials session.\r\nUsers do not have access to another users session.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-write ````",
"operationId": "JobOrdersFinancialsMassupdateSessionsBySessionIdCancelPost",
"parameters": [
{
"name": "sessionId",
"in": "path",
"description": "The Id of the Mass Update Session.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/JobOrders/financials/massupdate/sessions/{sessionId}/commit": {
"post": {
"tags": [
"JobOrders"
],
"summary": "Commit Mass Update Financials Session",
"description": "Commits the results of the calculations and updates the financial details on all orders and assignments in the session. \r\nUsers do not have access to another users session.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-write ````",
"operationId": "JobOrdersFinancialsMassupdateSessionsBySessionIdCommitPost",
"parameters": [
{
"name": "sessionId",
"in": "path",
"description": "The Id of the Mass Update Session.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"202": {
"description": "Accepted",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.MassUpdateFinancials.StageMassUpdateFinancialsOnJobOrderAndAsg.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.MassUpdateFinancials.StageMassUpdateFinancialsOnJobOrderAndAsg.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.MassUpdateFinancials.StageMassUpdateFinancialsOnJobOrderAndAsg.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.MassUpdateFinancials.StageMassUpdateFinancialsOnJobOrderAndAsg.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.MassUpdateFinancials.StageMassUpdateFinancialsOnJobOrderAndAsg.Result"
}
}
}
}
}
}
},
"/JobOrders/financials/massupdate/sessions/{sessionId}/results": {
"get": {
"tags": [
"JobOrders"
],
"summary": "Get Mass Update Financials Results",
"description": "The will return the results of the calculation. \r\nUsers do not have access to another users session.\r\nThe values in a session are stored temporarily and will be deleted two days after they are created.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-write ````",
"operationId": "JobOrdersFinancialsMassupdateSessionsBySessionIdResultsGet",
"parameters": [
{
"name": "sessionId",
"in": "path",
"description": "The Id of the Mass Update Session.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "showOnlyExcludeFromUpdate",
"in": "query",
"description": "If true, only returns items that will be excluded from the update. Defaults to false.",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "orderBy",
"in": "query",
"description": "Used to order the results by one of the returned columns. If not specified the system sorts by Job Order Id and then Assignment Id.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "orderByAscending",
"in": "query",
"description": "Used to specify the sort order. If not specified the system orders ascending.",
"style": "form",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.MassUpdateFinancials.MassUpdateJobOrderFinancialsResults.CalculationResult, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.MassUpdateFinancials.MassUpdateJobOrderFinancialsResults.CalculationResult, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.MassUpdateFinancials.MassUpdateJobOrderFinancialsResults.CalculationResult, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.MassUpdateFinancials.MassUpdateJobOrderFinancialsResults.CalculationResult, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.MassUpdateFinancials.MassUpdateJobOrderFinancialsResults.CalculationResult, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.MassUpdateFinancials.MassUpdateJobOrderFinancialsResults.CalculationResult, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.MassUpdateFinancials.MassUpdateJobOrderFinancialsResults.CalculationResult, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/JobOrders/financials/massupdate/sessions/{sessionId}/status": {
"get": {
"tags": [
"JobOrders"
],
"summary": "Get Status for Mass Update Financials Session",
"description": "The will return the status of the job order financials calculation and commit jobs.\r\nUsers do not have access to another users session.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-write ````",
"operationId": "JobOrdersFinancialsMassupdateSessionsBySessionIdStatusGet",
"parameters": [
{
"name": "sessionId",
"in": "path",
"description": "The Id of the Mass Update Session.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.MassUpdateFinancials.MassUpdateCalculationStatus.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.MassUpdateFinancials.MassUpdateCalculationStatus.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.MassUpdateFinancials.MassUpdateCalculationStatus.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.MassUpdateFinancials.MassUpdateCalculationStatus.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.MassUpdateFinancials.MassUpdateCalculationStatus.Result"
}
}
}
}
}
}
},
"/Messages/counts": {
"get": {
"tags": [
"Messages"
],
"summary": "Get Message Counts",
"description": "Gets message counts grouped by the provided OriginTypeId\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): message-read or message-write ````",
"operationId": "MessagesCountsGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of grouped message counts to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of grouped message counts to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "groupByOriginTypeId",
"in": "query",
"description": "Messages counts will be calculated by grouping by the specified OriginTypeId.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "startDate",
"in": "query",
"description": "Only messages more recent than the specified date will be included in counts.",
"required": true,
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "endDate",
"in": "query",
"description": "Only messages older than the specified date will be in counts.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "authorSrIdent",
"in": "query",
"description": "Limits the results to messages authored by the use with the specified srIdent.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "teamId",
"in": "query",
"description": "Limits the results to messages authored by users belonging to the specified team. A list of teams can be fetched via the ServiceRepTeams datalist.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "messageActionTypeId",
"in": "query",
"description": "Limits the results to messages with actions of the specified message action type. A list of message action types can be fetched via the MessageActionTypes datalist.",
"style": "form",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "linkedToOriginTypeId",
"in": "query",
"description": "Limits the results to messages that are linked to the specified OriginTypeId.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.MessageAggregateQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.MessageAggregateQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.MessageAggregateQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.MessageAggregateQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.MessageAggregateQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.MessageAggregateQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.MessageAggregateQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Messages/stream": {
"get": {
"tags": [
"Messages"
],
"summary": "Get Message Stream",
"description": "Returns a stream of message starting in chronological order with the most recent messages first.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): message-read or message-write ````",
"operationId": "MessagesStreamGet",
"parameters": [
{
"name": "FromId",
"in": "query",
"description": "Used for paging. Request messages including and more recent than the specified Id.",
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "SkipId",
"in": "query",
"description": "DEPRECATED. Please use FromId instead. Skip all messages more recent than the one with the specified Id. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int64",
"deprecated": true
}
},
{
"name": "Take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "AuthorSrIdent",
"in": "query",
"description": "Limits the results to messages authored by the use with the specified Service Rep Id.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "TeamId",
"in": "query",
"description": "Limits the results to messages authored by users belonging to the specified team. A list of teams can be fetched via the ServiceRepTeams datalist.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "MessageActionTypeId",
"in": "query",
"description": "Limits the results to messages with actions of the specified message action type. A list of message action types can be fetched via the MessageActionTypes datalist.",
"style": "form",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "MessageActionId",
"in": "query",
"description": "Limits the results to messages with actions of the specified message action. A list of message actions can be fetched via the MessageActions datalist.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "DateLookbackLimit",
"in": "query",
"description": "Limits how far back in time to look for messages. Changing this value will impact performance.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "LinkedToOriginTypeId",
"in": "query",
"description": "Limits the results to only messages linked to the specified origin type. This parameter is required if LinkedToOriginId is provided.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "LinkedToOriginId",
"in": "query",
"description": "Limits the results to only messages linked to the specified OriginTypeId/OriginId pair. LinkedToOriginTypeId is required if this parameter is provided.",
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "MessageText",
"in": "query",
"description": "Limits the results to messages with text that contains words or phrases similar to the supplied value.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "IsForWidget",
"in": "query",
"description": "Indicates whether or not this is to be run for a widget. If set to true, only TeamId and Take will be filtered on.",
"style": "form",
"schema": {
"type": "boolean",
"deprecated": true
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.CursorPagedList`1[[TwApi.Services.System.Service.Commands.MessageStreamQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.CursorPagedList`1[[TwApi.Services.System.Service.Commands.MessageStreamQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.CursorPagedList`1[[TwApi.Services.System.Service.Commands.MessageStreamQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.CursorPagedList`1[[TwApi.Services.System.Service.Commands.MessageStreamQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.CursorPagedList`1[[TwApi.Services.System.Service.Commands.MessageStreamQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Onboarding/Actions/Employee/{employeeId}": {
"get": {
"tags": [
"Enrollment"
],
"summary": "Search Onboarding2 action metadata for a specific employee.",
"description": "Returns action-level rows for a single employee identified by employeeId.\r\nThe employee must be within the caller's hierarchy.\r\n \r\nRoute: GET /Onboarding/Actions/ByEmployee/{employeeId}\r\nAuthorization: ONBOARDING_READ (ServiceRep)\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): onboarding-read or onboarding-write ````",
"operationId": "OnboardingActionsEmployeeByEmployeeIdGet",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The employee identifier.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "FormId",
"in": "query",
"description": "The optional Onboarding2 form identifier to filter by.",
"style": "form",
"schema": {
"maxLength": 255,
"minLength": 0,
"type": "string"
}
},
{
"name": "BranchId",
"in": "query",
"description": "The optional branch identifier to filter by.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Status",
"in": "query",
"description": "The optional status to filter by.\r\nValid values: requires_action, completed, expired (case-insensitive).",
"style": "form",
"schema": {
"maxLength": 100,
"minLength": 0,
"type": "string"
}
},
{
"name": "NextActionType",
"in": "query",
"description": "The optional assignee type (NextActionType) to filter by.\r\nValid values: employer_action, employee_action, none (case-insensitive).",
"style": "form",
"schema": {
"maxLength": 100,
"minLength": 0,
"type": "string"
}
},
{
"name": "CreatedAtAfter",
"in": "query",
"description": "Filter for records created after this date.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "CreatedAtBefore",
"in": "query",
"description": "Filter for records created before this date.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "ExpiresAtAfter",
"in": "query",
"description": "Filter for records expiring after this date.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "ExpiresAtBefore",
"in": "query",
"description": "Filter for records expiring before this date.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "DueAtAfter",
"in": "query",
"description": "Filter for records due after this date.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "DueAtBefore",
"in": "query",
"description": "Filter for records due before this date.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "CompletedAtAfter",
"in": "query",
"description": "Filter for records completed after this date.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "CompletedAtBefore",
"in": "query",
"description": "Filter for records completed before this date.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "UpdatedAtAfter",
"in": "query",
"description": "Filter for records last updated after this date.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "UpdatedAtBefore",
"in": "query",
"description": "Filter for records last updated before this date.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "ProductInstanceId",
"in": "query",
"description": "Optional product instance ID to filter by.",
"style": "form",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "OrderBy",
"in": "query",
"description": "The column to order by. Valid options: ActionName, DateCreated, DueDate, DateExpired, DateCompleted, DateUpdated, Status, Assignee.\r\nDefaults to \"DateCreated\" descending if not specified.",
"style": "form",
"schema": {
"maxLength": 255,
"minLength": 0,
"type": "string"
}
},
{
"name": "OrderByAscending",
"in": "query",
"description": "Whether to order ascending. Defaults to false (descending).",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "Skip",
"in": "query",
"description": "The number of records to skip for paging.",
"style": "form",
"schema": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer",
"format": "int32"
}
},
{
"name": "Take",
"in": "query",
"description": "The number of records to return for paging.",
"style": "form",
"schema": {
"maximum": 10000,
"minimum": 1,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "The search completed successfully.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Onboarding.Onboarding2ActionMetadataByEmployeeSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Onboarding.Onboarding2ActionMetadataByEmployeeSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Onboarding.Onboarding2ActionMetadataByEmployeeSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Onboarding.Onboarding2ActionMetadataByEmployeeSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Onboarding.Onboarding2ActionMetadataByEmployeeSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Onboarding.Onboarding2ActionMetadataByEmployeeSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Onboarding.Onboarding2ActionMetadataByEmployeeSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"400": {
"description": "The request was invalid."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden."
}
}
}
},
"/Onboarding/Actions/Employees": {
"get": {
"tags": [
"Enrollment"
],
"summary": "List employees with onboarding actions.",
"description": "Returns one row per employee who has onboarding actions matching the given filters.\r\nEach row includes employee details and a count of active actions requiring employee attention.\r\n \r\nRoute: GET /Onboarding/Actions/Employees\r\nAuthorization: ONBOARDING_READ (ServiceRep)\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): onboarding-read or onboarding-write ````",
"operationId": "OnboardingActionsEmployeesGet",
"parameters": [
{
"name": "FormId",
"in": "query",
"description": "The optional Onboarding2 form identifier to filter by.",
"style": "form",
"schema": {
"maxLength": 255,
"minLength": 0,
"type": "string"
}
},
{
"name": "FirstName",
"in": "query",
"description": "The optional employee first name to filter by (partial match).",
"style": "form",
"schema": {
"maxLength": 255,
"minLength": 0,
"type": "string"
}
},
{
"name": "LastName",
"in": "query",
"description": "The optional employee last name to filter by (partial match).",
"style": "form",
"schema": {
"maxLength": 255,
"minLength": 0,
"type": "string"
}
},
{
"name": "BranchId",
"in": "query",
"description": "The optional branch identifier to filter by.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Status",
"in": "query",
"description": "The optional status to filter by.\r\nValid values: requires_action, completed, expired (case-insensitive).",
"style": "form",
"schema": {
"maxLength": 100,
"minLength": 0,
"type": "string"
}
},
{
"name": "NextActionType",
"in": "query",
"description": "The optional assignee type (NextActionType) to filter by.\r\nValid values: employer_action, employee_action, none (case-insensitive).",
"style": "form",
"schema": {
"maxLength": 100,
"minLength": 0,
"type": "string"
}
},
{
"name": "CreatedAtAfter",
"in": "query",
"description": "Filter for records created after this date.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "CreatedAtBefore",
"in": "query",
"description": "Filter for records created before this date.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "ExpiresAtAfter",
"in": "query",
"description": "Filter for records expiring after this date.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "ExpiresAtBefore",
"in": "query",
"description": "Filter for records expiring before this date.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "DueAtAfter",
"in": "query",
"description": "Filter for records due after this date.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "DueAtBefore",
"in": "query",
"description": "Filter for records due before this date.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "CompletedAtAfter",
"in": "query",
"description": "Filter for records completed after this date.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "CompletedAtBefore",
"in": "query",
"description": "Filter for records completed before this date.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "UpdatedAtAfter",
"in": "query",
"description": "Filter for records last updated after this date.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "UpdatedAtBefore",
"in": "query",
"description": "Filter for records last updated before this date.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "ProductInstanceId",
"in": "query",
"description": "Optional product instance ID to filter by.",
"style": "form",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "StaffingSpecialistId",
"in": "query",
"description": "Optional staffing specialist service rep identifier to filter by.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "OrderBy",
"in": "query",
"description": "The column to order by. Valid options: EmployeeName, Branch.\r\nDefaults to \"EmployeeName\" descending if not specified.",
"style": "form",
"schema": {
"maxLength": 255,
"minLength": 0,
"type": "string"
}
},
{
"name": "OrderByAscending",
"in": "query",
"description": "Whether to order ascending. Defaults to false (descending).",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "Skip",
"in": "query",
"description": "The number of records to skip for paging.",
"style": "form",
"schema": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer",
"format": "int32"
}
},
{
"name": "Take",
"in": "query",
"description": "The number of records to return for paging.",
"style": "form",
"schema": {
"maximum": 10000,
"minimum": 1,
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "The search completed successfully.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Onboarding.Onboarding2ActionMetadataEmployeeList.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Onboarding.Onboarding2ActionMetadataEmployeeList.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Onboarding.Onboarding2ActionMetadataEmployeeList.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Onboarding.Onboarding2ActionMetadataEmployeeList.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Onboarding.Onboarding2ActionMetadataEmployeeList.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Onboarding.Onboarding2ActionMetadataEmployeeList.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Onboarding.Onboarding2ActionMetadataEmployeeList.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"400": {
"description": "The request was invalid."
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden."
}
}
}
},
"/Paycards/adp/enrollments/{proxyId}/status": {
"get": {
"tags": [
"Paycards"
],
"summary": "Get Enrollment Status",
"description": "Get the enrollment status for an ADP ALINE Card\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): payroll-write ````",
"operationId": "PaycardsAdpEnrollmentsByProxyIdStatusGet",
"parameters": [
{
"name": "proxyId",
"in": "path",
"description": "string identifier of the proxy Id used to Enroll paycard request",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.Adp.Service.Commands.ADPEnrollmentStatusQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.Adp.Service.Commands.ADPEnrollmentStatusQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.Adp.Service.Commands.ADPEnrollmentStatusQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.Adp.Service.Commands.ADPEnrollmentStatusQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.Adp.Service.Commands.ADPEnrollmentStatusQuery.Result"
}
}
}
}
}
}
},
"/Paycards/Checks": {
"get": {
"tags": [
"Paycards"
],
"summary": "Get Paycard Checks",
"description": "Get paged list of paycard checks ordered by the paycard check Id. Paycard checks are the line items created from payroll which are to be added to paycard funding runs for processing.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): payroll-read ````",
"operationId": "PaycardsChecksGet",
"parameters": [
{
"name": "payrollrunId",
"in": "query",
"description": "Optional filter to limit the list to the payrollrunId of the check the paycard check is created from.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "paycardVendorId",
"in": "query",
"description": "Optional filter on the paycard vendor. Valid values can be found at datalists/paycardvendors",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "isAvailableForNewFundingRun",
"in": "query",
"description": "If set to true, only paycard checks that can be put in a new funding run will be returned. If set to false, only paycard checks that are in a funding run or have already been funded will be returned. If not set, all paycard checks are returned.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "employerId",
"in": "query",
"description": "Optional filter on the employer Id of the paycard check. Valid values can be found at datalists/employers",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of paycard checks to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of paycard checks to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.PaycardChecks.PaycardChecksQuery.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.PaycardChecks.PaycardChecksQuery.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.PaycardChecks.PaycardChecksQuery.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.PaycardChecks.PaycardChecksQuery.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.PaycardChecks.PaycardChecksQuery.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.PaycardChecks.PaycardChecksQuery.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.PaycardChecks.PaycardChecksQuery.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Paycards/Checks/{id}/updatePaycardInformation": {
"post": {
"tags": [
"Paycards"
],
"summary": "Update Paycard Check Banking Information",
"description": "Updates the paycard check banking information to match the employee's current active paycard. This can only be done if the paycard check is not processed and the employee's electronic pay is active and setup with a verified paycard. \r\n This is typically used when the employee's paycard changes after the paycheck has been calculated or if a paycard has errors during funding.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): payroll-write ````",
"operationId": "PaycardsChecksByIdUpdatePaycardInformationPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the paycard check.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Paycards/enrollment": {
"post": {
"tags": [
"Paycards"
],
"summary": "Enroll a person into a paycard",
"description": "Enrolls a person into a paycard. Depending upon the Paycard Vendor Id the data requirements on the request will change.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): payroll-write ````",
"operationId": "PaycardsEnrollmentPost",
"requestBody": {
"description": "The enrollment information",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.PaycardEnrollmentRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.PaycardEnrollmentRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.PaycardEnrollmentRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.PaycardEnrollmentRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.PaycardEnrollmentRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.PaycardEnrollmentRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.PaycardEnrollmentRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.PaycardEnrollmentRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Paycards.TryEnrollPaycard.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Paycards.TryEnrollPaycard.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Paycards.TryEnrollPaycard.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Paycards.TryEnrollPaycard.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Paycards.TryEnrollPaycard.Result"
}
}
}
}
}
}
},
"/Paycards/FundingRuns": {
"post": {
"tags": [
"Paycards"
],
"summary": "Create Paycard Funding Run",
"description": "Creates a new paycard funding run\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): payroll-write ````",
"operationId": "PaycardsFundingRunsPost",
"requestBody": {
"description": "The new Funding Run request.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateFundingRunRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateFundingRunRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateFundingRunRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateFundingRunRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateFundingRunRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateFundingRunRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateFundingRunRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateFundingRunRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.PaycardFundingRuns.CreatePaycardFundingRunCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.PaycardFundingRuns.CreatePaycardFundingRunCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.PaycardFundingRuns.CreatePaycardFundingRunCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.PaycardFundingRuns.CreatePaycardFundingRunCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.PaycardFundingRuns.CreatePaycardFundingRunCommand.Result"
}
}
}
}
}
},
"get": {
"tags": [
"Paycards"
],
"summary": "Get Paycard Funding Runs",
"description": "Get paged list of paycard funding runs ordered by the paycard funding run id descending.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): payroll-write ````",
"operationId": "PaycardsFundingRunsGet",
"parameters": [
{
"name": "paycardVendorId",
"in": "query",
"description": "Optional filter on the paycard vendor of the funding run. Valid values can be found at datalists/paycardvendors",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "hasError",
"in": "query",
"description": "If set to true, only funding runs with errors will be returned. If set to false, only funding runs without errors will be returned. If not set, all runs are returned.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "isComplete",
"in": "query",
"description": "If set to true, only funding runs that have been processed will be returned. If set to false, only funding runs that have not completed processing will be returned. If not set, all runs are returned.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of paycard funding runs to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of paycard funding runs to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.PaycardFundingRuns.PaycardFundingRunsQuery.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.PaycardFundingRuns.PaycardFundingRunsQuery.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.PaycardFundingRuns.PaycardFundingRunsQuery.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.PaycardFundingRuns.PaycardFundingRunsQuery.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.PaycardFundingRuns.PaycardFundingRunsQuery.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.PaycardFundingRuns.PaycardFundingRunsQuery.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.PaycardFundingRuns.PaycardFundingRunsQuery.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Paycards/FundingRuns/{id}": {
"get": {
"tags": [
"Paycards"
],
"summary": "Get Paycard Funding Run",
"description": "Get paycard funding run details\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): payroll-write ````",
"operationId": "PaycardsFundingRunsByIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the paycard funding run",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.PaycardFundingRuns.PaycardFundingRunsQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.PaycardFundingRuns.PaycardFundingRunsQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.PaycardFundingRuns.PaycardFundingRunsQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.PaycardFundingRuns.PaycardFundingRunsQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.PaycardFundingRuns.PaycardFundingRunsQuery.Result"
}
}
}
}
}
}
},
"/Paycards/FundingRuns/{id}/cancel": {
"post": {
"tags": [
"Paycards"
],
"summary": "Cancel Paycard Funding Run",
"description": "Cancels a paycard funding run. If the funding run is currently being processed the DateCancellationRequested will be set on the paycard funding run. This will act\r\n as a cancellation request. If the paycard funding run status is 'New' then the funding run members will be marked 'Canceled' and the paycard checks will be released so that \r\n they may be funded in a different run. Canceled runs may still contain funded paycard checks.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): payroll-write ````",
"operationId": "PaycardsFundingRunsByIdCancelPost",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Paycards/FundingRuns/{id}/fundingRunMembers": {
"get": {
"tags": [
"Paycards"
],
"summary": "Get Paycard Funding Run Members",
"description": "Gets a paged list of members that are included in the funding run ordered by the funding run member Id. The members of a funding run are linked to the paycard checks which can be found at paycards/paycardChecks.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): payroll-write ````",
"operationId": "PaycardsFundingRunsByIdFundingRunMembersGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the paycard funding run.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "employeeId",
"in": "query",
"description": "Optional filter to limit the list to Id of the employee.",
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "hasError",
"in": "query",
"description": "Optional filter to limit the list to only return funding run members that have had an error.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of paycard funding run members to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of paycard funding run members to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.PaycardFundingRuns.PaycardFundingRunMembersQuery.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.PaycardFundingRuns.PaycardFundingRunMembersQuery.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.PaycardFundingRuns.PaycardFundingRunMembersQuery.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.PaycardFundingRuns.PaycardFundingRunMembersQuery.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.PaycardFundingRuns.PaycardFundingRunMembersQuery.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.PaycardFundingRuns.PaycardFundingRunMembersQuery.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.PaycardFundingRuns.PaycardFundingRunMembersQuery.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Paycards"
],
"summary": "Create Funding Run Members",
"description": "Adds paycard checks to the paycard funding run and creates funding run members.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): payroll-write ````",
"operationId": "PaycardsFundingRunsByIdFundingRunMembersPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the paycard funding run.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "Request that contains a list of paycard checks to add to a paycard funding run. Valid values may be found at GET /paycardChecks.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreatePaycardFundingRunMemberRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreatePaycardFundingRunMemberRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreatePaycardFundingRunMemberRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreatePaycardFundingRunMemberRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreatePaycardFundingRunMemberRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreatePaycardFundingRunMemberRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreatePaycardFundingRunMemberRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreatePaycardFundingRunMemberRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.PaycardFundingRuns.CreatePaycardFundingRunMembersCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.PaycardFundingRuns.CreatePaycardFundingRunMembersCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.PaycardFundingRuns.CreatePaycardFundingRunMembersCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.PaycardFundingRuns.CreatePaycardFundingRunMembersCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.PaycardFundingRuns.CreatePaycardFundingRunMembersCommand.Result"
}
}
}
}
}
}
},
"/Paycards/FundingRuns/{id}/fundingRunMembers/{fundingRunMemberId}": {
"get": {
"tags": [
"Paycards"
],
"summary": "Get Paycard Funding Run Member",
"description": "Returns a paycard funding run member.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): payroll-write ````",
"operationId": "PaycardsFundingRunsByIdFundingRunMembersByFundingRunMemberIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the paycard funding run.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "fundingRunMemberId",
"in": "path",
"description": "The Id of the paycard funding run member.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.PaycardFundingRuns.PaycardFundingRunMembersQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.PaycardFundingRuns.PaycardFundingRunMembersQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.PaycardFundingRuns.PaycardFundingRunMembersQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.PaycardFundingRuns.PaycardFundingRunMembersQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.PaycardFundingRuns.PaycardFundingRunMembersQuery.Result"
}
}
}
}
}
},
"delete": {
"tags": [
"Paycards"
],
"summary": "Delete Paycard Funding Run Member",
"description": "Deletes a paycard funding run member from a paycard funding run. The paycard check associated will be available for another funding run.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): payroll-write ````",
"operationId": "PaycardsFundingRunsByIdFundingRunMembersByFundingRunMemberIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the paycard funding run.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "fundingRunMemberId",
"in": "path",
"description": "The Id of the paycard funding run member.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Paycards/FundingRuns/{id}/fundingRunMembers/validationMessages": {
"get": {
"tags": [
"Paycards"
],
"summary": "Get Paycard Funding Run Member Validation Messages",
"description": "Will review the data in the funding run and return any errors and warnings. Funding Run Members noted with IsError = true will likely fail. \r\n It is recommended that processing of the run is not done until all errors are resolved or the paycard funding run member is removed from the run.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): payroll-write ````",
"operationId": "PaycardsFundingRunsByIdFundingRunMembersValidationMessagesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the paycard funding run.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "isError",
"in": "query",
"description": "Optional filter on the isError column. When true, the list will be limited to only the items with IsError = true. When false, only warnings are returned. All items are returned when not specified.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "fundingRunMemberId",
"in": "query",
"description": "Optional filter to limit the list to validation messages from a specific paycard funding run member.",
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of validation messages to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of validation messages to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.PaycardFundingRuns.PaycardFundingRunValidateMembersQuery.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.PaycardFundingRuns.PaycardFundingRunValidateMembersQuery.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.PaycardFundingRuns.PaycardFundingRunValidateMembersQuery.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.PaycardFundingRuns.PaycardFundingRunValidateMembersQuery.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.PaycardFundingRuns.PaycardFundingRunValidateMembersQuery.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.PaycardFundingRuns.PaycardFundingRunValidateMembersQuery.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.PaycardFundingRuns.PaycardFundingRunValidateMembersQuery.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Paycards/FundingRuns/{id}/stageForProcessing": {
"post": {
"tags": [
"Paycards"
],
"summary": "Stage a Paycard Funding Run for Processing",
"description": "Stages a paycard funding run for processing. The run will be validated for critical errors and will be set to a 'Queued' status.\r\n The TempWorks Payroll Service will process the run and fund the members staged in the paycard funding run.\r\n Use GET paycardFundingRuns/{id} to obtain the current status of the run. \r\n Use GET paycardFundingRuns/{id}/fundingRunMembers to obtain the current status of each member while the run is processing.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): payroll-write ````",
"operationId": "PaycardsFundingRunsByIdStageForProcessingPost",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"202": {
"description": "Accepted"
}
}
}
},
"/Paycards/validate": {
"post": {
"tags": [
"Paycards"
],
"summary": "Validate Paycard",
"description": "Will validate a paycard using the Account Id. Returns information specifying if the paycard can be issued and if it can be funded. The response will contain different objects based upon the paycard vendor Id supplied.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): payroll-write ````",
"operationId": "PaycardsValidatePost",
"requestBody": {
"description": "The Paycard information",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.ValidatePaycardRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.ValidatePaycardRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.ValidatePaycardRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.ValidatePaycardRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.ValidatePaycardRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.ValidatePaycardRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.ValidatePaycardRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.ValidatePaycardRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Paycards.ValidatePaycardCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Paycards.ValidatePaycardCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Paycards.ValidatePaycardCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Paycards.ValidatePaycardCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Paycards.ValidatePaycardCommand.Result"
}
}
}
}
}
}
},
"/Paycards/validate/address": {
"post": {
"tags": [
"Paycards"
],
"summary": "Used to validate the address for a paycard enrollment.",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): payroll-write ````",
"operationId": "PaycardsValidateAddressPost",
"requestBody": {
"description": "",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.ValidatePaycardAddressRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.ValidatePaycardAddressRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.ValidatePaycardAddressRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.ValidatePaycardAddressRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.ValidatePaycardAddressRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.ValidatePaycardAddressRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.ValidatePaycardAddressRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.ValidatePaycardAddressRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Paycards.ValidatePaycardAddressCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Paycards.ValidatePaycardAddressCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Paycards.ValidatePaycardAddressCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Paycards.ValidatePaycardAddressCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Paycards.ValidatePaycardAddressCommand.Result"
}
}
}
}
}
}
},
"/Prospects": {
"post": {
"tags": [
"Prospects"
],
"summary": "Create Prospect",
"description": "Creates a Prospect Contact.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): prospect-write ````",
"operationId": "ProspectsPost",
"requestBody": {
"description": "The request body containing information about the new prospect.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.API.Models.CreateProspectRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.API.Models.CreateProspectRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.API.Models.CreateProspectRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.API.Models.CreateProspectRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.API.Models.CreateProspectRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.API.Models.CreateProspectRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.API.Models.CreateProspectRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.API.Models.CreateProspectRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.Service.Commands.CreateProspect.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.Service.Commands.CreateProspect.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.Service.Commands.CreateProspect.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.Service.Commands.CreateProspect.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.Service.Commands.CreateProspect.Result"
}
}
}
}
},
"deprecated": true
}
},
"/Prospects/{id}": {
"get": {
"tags": [
"Prospects"
],
"summary": "Get Prospect Details",
"description": "Gets details about the specified prospect.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): prospect-read or prospect-write ````",
"operationId": "ProspectsByIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the prospect.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Prospects.ProspectDetails.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Prospects.ProspectDetails.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Prospects.ProspectDetails.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Prospects.ProspectDetails.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Prospects.ProspectDetails.Result"
}
}
}
}
},
"deprecated": true
},
"patch": {
"tags": [
"Prospects"
],
"summary": "Patch Prospect",
"description": "\r\n\r\n Allows for Json patching to be performed against prospect fields.\r\n More information about PATCHING, see https://developer.ontempworks.com/docs/your-request\r\n \r\n\r\n\r\n Valid Patch paths: /Name(string), /Department(string), /PhoneNumber(string), /PhoneNumberCountryCallingCode(int?), /EmailAddress(string), /Notes(string), /PrimaryProspectContactId(long?), /Source(string), /OwnedByServiceRepId(int?), /TeamId(int?), /ProspectStatusId(long), /PrimaryMessageId(long?)\r\n \n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): prospect-write ````",
"operationId": "ProspectsByIdPatch",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the prospect.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "A Json array of patch operations to be performed.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":"SampleProspect","path":"/Name","op":"replace"},{"value":"SampleNote","path":"/Notes","op":"add"},{"path":"/Notes","op":"remove"},{"path":"/Notes","op":"copy","from":"/Source"},{"path":"/Notes","op":"move","from":"/Source"},{"value":"SampleProspect","path":"/Name","op":"test"}]
},
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":"SampleProspect","path":"/Name","op":"replace"},{"value":"SampleNote","path":"/Notes","op":"add"},{"path":"/Notes","op":"remove"},{"path":"/Notes","op":"copy","from":"/Source"},{"path":"/Notes","op":"move","from":"/Source"},{"value":"SampleProspect","path":"/Name","op":"test"}]
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":"SampleProspect","path":"/Name","op":"replace"},{"value":"SampleNote","path":"/Notes","op":"add"},{"path":"/Notes","op":"remove"},{"path":"/Notes","op":"copy","from":"/Source"},{"path":"/Notes","op":"move","from":"/Source"},{"value":"SampleProspect","path":"/Name","op":"test"}]
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":"SampleProspect","path":"/Name","op":"replace"},{"value":"SampleNote","path":"/Notes","op":"add"},{"path":"/Notes","op":"remove"},{"path":"/Notes","op":"copy","from":"/Source"},{"path":"/Notes","op":"move","from":"/Source"},{"value":"SampleProspect","path":"/Name","op":"test"}]
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":"SampleProspect","path":"/Name","op":"replace"},{"value":"SampleNote","path":"/Notes","op":"add"},{"path":"/Notes","op":"remove"},{"path":"/Notes","op":"copy","from":"/Source"},{"path":"/Notes","op":"move","from":"/Source"},{"value":"SampleProspect","path":"/Name","op":"test"}]
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": "\r\n \r\n \r\n replace\r\n /Name\r\n SampleProspect\r\n \r\n \r\n \r\n add\r\n /Notes\r\n SampleNote\r\n \r\n \r\n \r\n remove\r\n /Notes\r\n \r\n \r\n \r\n /Source\r\n copy\r\n /Notes\r\n \r\n \r\n \r\n /Source\r\n move\r\n /Notes\r\n \r\n \r\n \r\n \r\n test\r\n /Name\r\n SampleProspect\r\n \r\n"
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": "\r\n \r\n \r\n replace\r\n /Name\r\n SampleProspect\r\n \r\n \r\n \r\n add\r\n /Notes\r\n SampleNote\r\n \r\n \r\n \r\n remove\r\n /Notes\r\n \r\n \r\n \r\n /Source\r\n copy\r\n /Notes\r\n \r\n \r\n \r\n /Source\r\n move\r\n /Notes\r\n \r\n \r\n \r\n \r\n test\r\n /Name\r\n SampleProspect\r\n \r\n"
},
"application/*+xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": "\r\n \r\n \r\n replace\r\n /Name\r\n SampleProspect\r\n \r\n \r\n \r\n add\r\n /Notes\r\n SampleNote\r\n \r\n \r\n \r\n remove\r\n /Notes\r\n \r\n \r\n \r\n /Source\r\n copy\r\n /Notes\r\n \r\n \r\n \r\n /Source\r\n move\r\n /Notes\r\n \r\n \r\n \r\n \r\n test\r\n /Name\r\n SampleProspect\r\n \r\n"
}
}
},
"responses": {
"204": {
"description": "No Content"
}
},
"deprecated": true
},
"delete": {
"tags": [
"Prospects"
],
"summary": "Delete Prospect",
"description": "Deletes a Prospect. Prospects that have been converted to Customers cannot be deleted.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): prospect-write ````",
"operationId": "ProspectsByIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the prospect.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
},
"deprecated": true
}
},
"/Prospects/{id}/address": {
"put": {
"tags": [
"Prospects"
],
"summary": "Update Prospect Address",
"description": "Updates the address on a Prospect.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): prospect-write ````",
"operationId": "ProspectsByIdAddressPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the prospect.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The request body containing updated address information.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.API.Models.UpdateProspectAddressRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.API.Models.UpdateProspectAddressRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.API.Models.UpdateProspectAddressRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.API.Models.UpdateProspectAddressRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.API.Models.UpdateProspectAddressRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.API.Models.UpdateProspectAddressRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.API.Models.UpdateProspectAddressRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.API.Models.UpdateProspectAddressRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
},
"deprecated": true
}
},
"/Prospects/{id}/contacts": {
"get": {
"tags": [
"Prospects"
],
"summary": "Get Prospect Contacts",
"description": "Gets a list of Prospect Contacts for the Prospect.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): prospect-read or prospect-write ````",
"operationId": "ProspectsByIdContactsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the prospect.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Prospects.Service.Commands.ProspectContactList.Result, Prospects.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Prospects.Service.Commands.ProspectContactList.Result, Prospects.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Prospects.Service.Commands.ProspectContactList.Result, Prospects.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Prospects.Service.Commands.ProspectContactList.Result, Prospects.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Prospects.Service.Commands.ProspectContactList.Result, Prospects.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Prospects.Service.Commands.ProspectContactList.Result, Prospects.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Prospects.Service.Commands.ProspectContactList.Result, Prospects.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
},
"deprecated": true
},
"post": {
"tags": [
"Prospects"
],
"summary": "Create Prospect Contact",
"description": "Creates a Prospect Contact.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): prospect-write ````",
"operationId": "ProspectsByIdContactsPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the prospect.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The request body containing information about the new prospect contact.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.API.Models.CreateProspectContactRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.API.Models.CreateProspectContactRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.API.Models.CreateProspectContactRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.API.Models.CreateProspectContactRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.API.Models.CreateProspectContactRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.API.Models.CreateProspectContactRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.API.Models.CreateProspectContactRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.API.Models.CreateProspectContactRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.Service.Commands.CreateProspectContact.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.Service.Commands.CreateProspectContact.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.Service.Commands.CreateProspectContact.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.Service.Commands.CreateProspectContact.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.Service.Commands.CreateProspectContact.Result"
}
}
}
}
},
"deprecated": true
}
},
"/Prospects/{id}/contacts/{prospectContactId}": {
"get": {
"tags": [
"Prospects"
],
"summary": "Get Prospect Contact",
"description": "Gets details about the Prospect Contact.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): prospect-read or prospect-write ````",
"operationId": "ProspectsByIdContactsByProspectContactIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the prospect.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "prospectContactId",
"in": "path",
"description": "The Id of the prospect contact.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.Service.Commands.ProspectContactList.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.Service.Commands.ProspectContactList.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.Service.Commands.ProspectContactList.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.Service.Commands.ProspectContactList.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.Service.Commands.ProspectContactList.Result"
}
}
}
}
},
"deprecated": true
},
"put": {
"tags": [
"Prospects"
],
"summary": "Update Prospect Contact",
"description": "Updates details about the a Prospect Contact.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): prospect-write ````",
"operationId": "ProspectsByIdContactsByProspectContactIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the prospect.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "prospectContactId",
"in": "path",
"description": "The Id of the prospect contact.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The request body containing updated information about the prospect contact.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.API.Models.CreateProspectContactRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.API.Models.CreateProspectContactRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.API.Models.CreateProspectContactRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.API.Models.CreateProspectContactRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.API.Models.CreateProspectContactRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.API.Models.CreateProspectContactRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.API.Models.CreateProspectContactRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.API.Models.CreateProspectContactRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
},
"deprecated": true
},
"delete": {
"tags": [
"Prospects"
],
"summary": "Delete Prospect",
"description": "Deletes a Prospect Contact. Contacts cannot be removed from a Prospect that has been converted to a Customers.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): prospect-write ````",
"operationId": "ProspectsByIdContactsByProspectContactIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the prospect.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "prospectContactId",
"in": "path",
"description": "The Id of the prospect contact.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
},
"deprecated": true
}
},
"/Prospects/{id}/convertToCustomer": {
"put": {
"tags": [
"Prospects"
],
"summary": "Convert Prospect To Customer",
"description": "Creates a customer record based off of information in the Prospect. Prospect Contacts can be converted to Contacts at this time as well.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): prospect-write ````",
"operationId": "ProspectsByIdConvertToCustomerPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the prospect.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.API.Models.ConvertProspectToCustomerRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.API.Models.ConvertProspectToCustomerRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.API.Models.ConvertProspectToCustomerRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.API.Models.ConvertProspectToCustomerRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.API.Models.ConvertProspectToCustomerRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.API.Models.ConvertProspectToCustomerRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.API.Models.ConvertProspectToCustomerRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.API.Models.ConvertProspectToCustomerRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Customers.CreateCustomer.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Customers.CreateCustomer.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Customers.CreateCustomer.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Customers.CreateCustomer.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.Customers.CreateCustomer.Result"
}
}
}
}
},
"deprecated": true
}
},
"/Prospects/{id}/convertToCustomer/validate": {
"put": {
"tags": [
"Prospects"
],
"summary": "Validate Convert Prospect To Customer",
"description": "Performs the same validation as Convert Prospect To Customer but does not convert the Prospect to a Customer.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): prospect-write ````",
"operationId": "ProspectsByIdConvertToCustomerValidatePut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the prospect.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.API.Models.ConvertProspectToCustomerRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.API.Models.ConvertProspectToCustomerRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.API.Models.ConvertProspectToCustomerRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.API.Models.ConvertProspectToCustomerRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.API.Models.ConvertProspectToCustomerRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.API.Models.ConvertProspectToCustomerRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.API.Models.ConvertProspectToCustomerRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.API.Models.ConvertProspectToCustomerRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
},
"deprecated": true
}
},
"/Prospects/{id}/CustomData": {
"get": {
"tags": [
"Prospects"
],
"summary": "Get Custom Data",
"description": "Gets a list of Custom Data Properties for a Prospect.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): prospect-read or prospect-write ````",
"operationId": "ProspectsByIdCustomDataGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the prospect.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "includeInactiveProperties",
"in": "query",
"description": "When true, any properties that have been marked inactive will also be returned.",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.CustomData.EntityCustomDataQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.CustomData.EntityCustomDataQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.CustomData.EntityCustomDataQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.CustomData.EntityCustomDataQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.CustomData.EntityCustomDataQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.CustomData.EntityCustomDataQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.CustomData.EntityCustomDataQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
},
"deprecated": true
},
"put": {
"tags": [
"Prospects"
],
"summary": "Update Custom Data",
"description": "Updates the Custom Data Properties for a Prospect.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): prospect-write ````",
"operationId": "ProspectsByIdCustomDataPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the prospect.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The list of values to store.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.CustomData.UpdateEntityCustomDataRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.CustomData.UpdateEntityCustomDataRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.CustomData.UpdateEntityCustomDataRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.CustomData.UpdateEntityCustomDataRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.CustomData.UpdateEntityCustomDataRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.CustomData.UpdateEntityCustomDataRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.CustomData.UpdateEntityCustomDataRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.CustomData.UpdateEntityCustomDataRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
},
"deprecated": true
}
},
"/Prospects/{id}/documents": {
"get": {
"tags": [
"Prospects"
],
"summary": "Get Documents",
"description": "Get a list of documents linked to the prospect.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): prospect-read or prospect-write ````",
"operationId": "ProspectsByIdDocumentsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the prospect.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of documents to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of documents to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "sortByAscending",
"in": "query",
"description": "true to sort by ASC, defaults to DESC",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "sortBy",
"in": "query",
"description": "Field to sort by, valid fields are \"DocumentType\" and \"DocumentDate\"",
"style": "form",
"schema": {
"type": "string",
"default": "DocumentDate"
}
},
{
"name": "filterByDocumentTypeId",
"in": "query",
"description": "DocumentTypeId to filter by",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Documents.GetEntityDocumentsQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Documents.GetEntityDocumentsQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Documents.GetEntityDocumentsQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Documents.GetEntityDocumentsQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Documents.GetEntityDocumentsQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Documents.GetEntityDocumentsQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Documents.GetEntityDocumentsQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
},
"deprecated": true
},
"post": {
"tags": [
"Prospects"
],
"summary": "Upload Document",
"description": "Uploads a document to the prospect. This requires a multipart form-data POST request. \r\nOne part must contain the file to upload and subsequent parts will be used to provide \r\nother data such as documentTypeId.\r\n\r\nFor more information about using formdata, see: https://developer.mozilla.org/en-US/docs/Web/API/FormData/FormData\r\nFor more information about using multimart/form-data, see: http://stackoverflow.com/questions/4526273/what-does-enctype-multipart-form-data-mean\r\nBelow is an example multipart/form-data POST request body:\r\n\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn\r\nContent-Disposition: form-data; name=\"file\"; filename=\"Test.txt\"\r\nContent-Type: text/plain\r\n\r\nThis is where the file content is placed! This is a valid for a text document!\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn\r\nContent-Disposition: form-data; name=\"fileName\"\r\n\r\nNewFileName.txt\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn\r\nContent-Disposition: form-data; name=\"expirationDate\"\r\n\r\n2012-12-21\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn\r\nContent-Disposition: form-data; name=\"documentTypeId\"\r\n\r\n1\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn\r\nContent-Disposition: form-data; name=\"version\"\r\n\r\n1\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn\r\nContent-Disposition: form-data; name=\"description\"\r\n\r\ntest\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn--\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): prospect-write ````",
"operationId": "ProspectsByIdDocumentsPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the prospect.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"201": {
"description": "Id of the new document",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
}
}
}
},
"deprecated": true
}
},
"/Prospects/{id}/documents/{documentId}": {
"get": {
"tags": [
"Prospects"
],
"summary": "Get Document Details",
"description": "Gets details about the specified document from the specified prospect.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): prospect-read or prospect-write ````",
"operationId": "ProspectsByIdDocumentsByDocumentIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the prospect.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "documentId",
"in": "path",
"description": "The Id of the document.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.GetEntityDocumentQuery.Document"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.GetEntityDocumentQuery.Document"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.GetEntityDocumentQuery.Document"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.GetEntityDocumentQuery.Document"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.GetEntityDocumentQuery.Document"
}
}
}
}
},
"deprecated": true
},
"put": {
"tags": [
"Prospects"
],
"summary": "Update Document Details",
"description": "Updates detail information about the document.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): prospect-write ````",
"operationId": "ProspectsByIdDocumentsByDocumentIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the prospect.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "documentId",
"in": "path",
"description": "The Id of the document.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The body of the request containing the updated details information.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Documents.UpdateEntityDocumentDetailsRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Documents.UpdateEntityDocumentDetailsRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Documents.UpdateEntityDocumentDetailsRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Documents.UpdateEntityDocumentDetailsRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Documents.UpdateEntityDocumentDetailsRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Documents.UpdateEntityDocumentDetailsRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Documents.UpdateEntityDocumentDetailsRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Documents.UpdateEntityDocumentDetailsRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
},
"deprecated": true
},
"delete": {
"tags": [
"Prospects"
],
"summary": "Delete Document",
"description": "Deletes the specified document.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): prospect-write ````",
"operationId": "ProspectsByIdDocumentsByDocumentIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the prospect.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "documentId",
"in": "path",
"description": "The Id of the document.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
},
"deprecated": true
}
},
"/Prospects/{id}/documents/{documentId}/bytes": {
"get": {
"tags": [
"Prospects"
],
"summary": "Get Document",
"description": "Gets the specified document from the specified prospect.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): prospect-read or prospect-write ````",
"operationId": "ProspectsByIdDocumentsByDocumentIdBytesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the prospect.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "documentId",
"in": "path",
"description": "The Id of the document.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "returnPdf",
"in": "query",
"description": "Used to indicated whether or not a PDF should be returned if the file is convertible to PDF",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "string",
"format": "byte"
}
},
"text/csv": {
"schema": {
"type": "string",
"format": "byte"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"type": "string",
"format": "byte"
}
},
"application/json": {
"schema": {
"type": "string",
"format": "byte"
}
},
"text/json": {
"schema": {
"type": "string",
"format": "byte"
}
},
"application/xml": {
"schema": {
"type": "string",
"format": "byte"
}
},
"text/xml": {
"schema": {
"type": "string",
"format": "byte"
}
}
}
}
},
"deprecated": true
}
},
"/Prospects/{id}/documents/metadata": {
"get": {
"tags": [
"Prospects"
],
"summary": "Get Documents Metadata",
"description": "Returns information about document creation restrictions.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): prospect-read or prospect-write ````",
"operationId": "ProspectsByIdDocumentsMetadataGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the prospect.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.DocumentMetadataQuery.Query"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.DocumentMetadataQuery.Query"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.DocumentMetadataQuery.Query"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.DocumentMetadataQuery.Query"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.DocumentMetadataQuery.Query"
}
}
}
}
},
"deprecated": true
}
},
"/Prospects/{id}/messages": {
"get": {
"tags": [
"Prospects"
],
"summary": "Get Messages",
"description": "Gets a list of messages linked to the Prospect. The Messages are ordered from newest to the oldest.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): prospect-read or prospect-write ````",
"operationId": "ProspectsByIdMessagesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the prospect.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of messages to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of messages to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "messageActionId",
"in": "query",
"description": "Optional filter on the Id of the message action. Valid values can be found in the Message Action List. ref: /datalists/messageactions",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "messageActionTypeId",
"in": "query",
"description": "Optional filter on the Id of the message action type. Valid values can be found in the Message Action Type List. ref: /datalists/messageactiontypes",
"style": "form",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "authorSrIdent",
"in": "query",
"description": "Optional filter on the Id of the Service Rep who created the message.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "startDate",
"in": "query",
"description": "Optional filter on the date of the message. Any messages created on or after the date supplied will be returned.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "endDate",
"in": "query",
"description": "Optional filter on the date of the message. Any messages created on or before the date supplied will be returned.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "orderBy",
"in": "query",
"description": "Optional parameter to specify the column to order by. Valid values are 'date', 'action', 'actiondescription','authorsrident','author','id', and 'message', Defaults to 'date'",
"style": "form",
"schema": {
"maxLength": 150,
"minLength": 0,
"type": "string"
}
},
{
"name": "orderByAscending",
"in": "query",
"description": "Optional parameter to specify the direction to order by. Specify true to order ascending.",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "messageText",
"in": "query",
"description": "Optional parameter to search on the message text. To search for any message which contains a word which starts with accep, the value would be: accep*",
"style": "form",
"schema": {
"maxLength": 1000,
"minLength": 0,
"type": "string"
}
},
{
"name": "limitToPrimaryMessages",
"in": "query",
"description": "Set to true to only return the primary messages. Currently only one primary message is supported. \r\n This can be set using the endpoint PATCH prospects/{id} and setting the value PrimaryMessageId.\r\n Optional filters such as start date and end date are ignored when this value is true.",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
},
"deprecated": true
},
"post": {
"tags": [
"Prospects"
],
"summary": "Create Message",
"description": "Creates a message and links it to the prospect.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): prospect-read or prospect-write ````",
"operationId": "ProspectsByIdMessagesPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the prospect",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The body of the request containing the information required to create the message.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateMessageWithLinkedDocumentsRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateMessageWithLinkedDocumentsRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateMessageWithLinkedDocumentsRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateMessageWithLinkedDocumentsRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateMessageWithLinkedDocumentsRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateMessageWithLinkedDocumentsRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateMessageWithLinkedDocumentsRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateMessageWithLinkedDocumentsRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
}
}
}
},
"deprecated": true
}
},
"/Prospects/{id}/messages/{messageId}": {
"get": {
"tags": [
"Prospects"
],
"summary": "Gets the details of a specific message.",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): prospect-read or prospect-write ````",
"operationId": "ProspectsByIdMessagesByMessageIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the prospect.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "messageId",
"in": "path",
"description": "The Id of the message.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageDetails"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageDetails"
}
}
}
}
},
"deprecated": true
}
},
"/Prospects/{id}/tasks": {
"get": {
"tags": [
"Prospects"
],
"summary": "Get Prospect Tasks",
"description": "Returns the list of tasks linked to the prospect and belonging to the current user.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): (prospect-read or prospect-write) and (task-read or task-write) ````",
"operationId": "ProspectsByIdTasksGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the prospect.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "TaskQueryType",
"in": "query",
"required": true,
"style": "form",
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Enums.TaskQueryTypes"
}
},
{
"name": "Skip",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Take",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "StartDueDate",
"in": "query",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "EndDueDate",
"in": "query",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "Priority",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "IncludeNullDueDates",
"in": "query",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "FilterText",
"in": "query",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "AssignedToServiceRepId",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "TeamId",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "CreatedByServiceRepId",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "IsPinned",
"in": "query",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "StartDateArchived",
"in": "query",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "EndDateArchived",
"in": "query",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "OrderBy",
"in": "query",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "OrderByAscending",
"in": "query",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "Tags",
"in": "query",
"style": "form",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Tasks.TaskListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Tasks.TaskListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Tasks.TaskListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Tasks.TaskListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Tasks.TaskListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Tasks.TaskListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Tasks.TaskListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
},
"deprecated": true
},
"post": {
"tags": [
"Prospects"
],
"summary": "Create Prospect Task",
"description": "Creates a task and links it to the prospect.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): prospect-write and task-write ````",
"operationId": "ProspectsByIdTasksPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the prospect",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The body of the request containing the information required to create the task.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateEntityTaskRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateEntityTaskRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateEntityTaskRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateEntityTaskRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateEntityTaskRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateEntityTaskRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateEntityTaskRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateEntityTaskRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.CreateTaskCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.CreateTaskCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.CreateTaskCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.CreateTaskCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.CreateTaskCommand.Result"
}
}
}
}
},
"deprecated": true
}
},
"/Prospects/{id}/tasks/{taskId}": {
"get": {
"tags": [
"Prospects"
],
"summary": "Get Prospect Task Details",
"description": "Gets more detailed information about a task pertaining to the prospect.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): (prospect-read or prospect-write) and (task-read or task-write) ````",
"operationId": "ProspectsByIdTasksByTaskIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the prospect",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.TaskDetailsQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.TaskDetailsQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.TaskDetailsQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.TaskDetailsQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.TaskDetailsQuery.Result"
}
}
}
}
},
"deprecated": true
},
"put": {
"tags": [
"Prospects"
],
"summary": "Update Prospect Task",
"description": "Updates a task linked to the prospect.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): prospect-write and task-write ````",
"operationId": "ProspectsByIdTasksByTaskIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the prospect",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The body of the request containing the updated task details.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.UpdateTaskRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.UpdateTaskRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.UpdateTaskRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.UpdateTaskRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.UpdateTaskRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.UpdateTaskRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.UpdateTaskRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.UpdateTaskRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
},
"deprecated": true
}
},
"/Prospects/{id}/tasks/{taskId}/archive": {
"put": {
"tags": [
"Prospects"
],
"summary": "Archive Prospect Task",
"description": "Archives the task linked to the prospect.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): prospect-write and task-write ````",
"operationId": "ProspectsByIdTasksByTaskIdArchivePut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the prospect",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
},
"deprecated": true
}
},
"/Prospects/{id}/tasks/{taskId}/assign": {
"put": {
"tags": [
"Prospects"
],
"summary": "Assign Prospect Task",
"description": "Assigns the task linked to the prospect.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): task-write ````",
"operationId": "ProspectsByIdTasksByTaskIdAssignPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the prospect",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The body of the request containing the new assignment details for the task.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
},
"deprecated": true
}
},
"/Prospects/{id}/tasks/{taskId}/pin": {
"put": {
"tags": [
"Prospects"
],
"summary": "Pin Prospect Task",
"description": "Pins the task linked to the prospect.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): prospect-write and task-write ````",
"operationId": "ProspectsByIdTasksByTaskIdPinPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the prospect",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
},
"deprecated": true
}
},
"/Prospects/{id}/tasks/{taskId}/unarchive": {
"put": {
"tags": [
"Prospects"
],
"summary": "Unarchive Prospect Task",
"description": "Unarchives the task linked to the prospect.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): prospect-write and task-write ````",
"operationId": "ProspectsByIdTasksByTaskIdUnarchivePut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the prospect",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
},
"deprecated": true
}
},
"/Prospects/{id}/tasks/{taskId}/unpin": {
"put": {
"tags": [
"Prospects"
],
"summary": "Unpin Prospect Task",
"description": "s the task linked to the prospect.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): prospect-write and task-write ````",
"operationId": "ProspectsByIdTasksByTaskIdUnpinPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the prospect",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "taskId",
"in": "path",
"description": "The Id of the task",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
},
"deprecated": true
}
},
"/Prospects/{prospectId}/messages/{messageId}": {
"put": {
"tags": [
"Prospects"
],
"summary": "Update Message",
"description": "Updates a message and links it to the prospect.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): prospect-read or prospect-write ````",
"operationId": "ProspectsByProspectIdMessagesByMessageIdPut",
"parameters": [
{
"name": "prospectId",
"in": "path",
"description": "The Id of the prospect",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "messageId",
"in": "path",
"description": "The Id of the message",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The body of the request containing the information required to update the message.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.UpdateMessageWithLinkedDocumentsRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.UpdateMessageWithLinkedDocumentsRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.UpdateMessageWithLinkedDocumentsRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.UpdateMessageWithLinkedDocumentsRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.UpdateMessageWithLinkedDocumentsRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.UpdateMessageWithLinkedDocumentsRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.UpdateMessageWithLinkedDocumentsRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.UpdateMessageWithLinkedDocumentsRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.UpdateContactMessageResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.UpdateContactMessageResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.UpdateContactMessageResult"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.UpdateContactMessageResult"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.UpdateContactMessageResult"
}
}
}
}
},
"deprecated": true
}
},
"/Prospects/{prospectId}/messages/{messageId}/documents": {
"post": {
"tags": [
"Prospects"
],
"summary": "Upload document to a message",
"description": "\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): prospect-write ````",
"operationId": "ProspectsByProspectIdMessagesByMessageIdDocumentsPost",
"parameters": [
{
"name": "prospectId",
"in": "path",
"description": "The Id of the prospect.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "messageId",
"in": "path",
"description": "The Id of the message.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"required": [
"DocumentName",
"DocumentTypeId"
],
"type": "object",
"properties": {
"File": {
"type": "string",
"format": "binary"
},
"DocumentName": {
"type": "string"
},
"DocumentTypeId": {
"type": "integer",
"format": "int32"
},
"Description": {
"maxLength": 255,
"type": "string"
},
"ExpirationDate": {
"type": "string",
"format": "date-time"
},
"Version": {
"type": "string"
}
}
},
"encoding": {
"File": {
"style": "form"
},
"DocumentName": {
"style": "form"
},
"DocumentTypeId": {
"style": "form"
},
"Description": {
"style": "form"
},
"ExpirationDate": {
"style": "form"
},
"Version": {
"style": "form"
}
}
}
}
},
"responses": {
"201": {
"description": "Id of the new document.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result"
}
}
}
}
},
"deprecated": true
}
},
"/ratesheets": {
"get": {
"tags": [
"RateSheets"
],
"summary": "Gets a list of Rate Sheets.",
"description": "Gets a list of Rate Sheets.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): ratesheet-read or ratesheet-write ````",
"operationId": "RatesheetsGet",
"parameters": [
{
"name": "EmployeeId",
"in": "query",
"description": "An optional Employee Id. Used to filter the rate sheet list.",
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "CustomerId",
"in": "query",
"description": "An optional Customer Id. Used to filter the rate sheet list.",
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "WorksiteId",
"in": "query",
"description": "An optional Worksite Id. Used to filter the rate sheet list.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "JobTitleId",
"in": "query",
"description": "An optional Job Title Id. Used to filter the rate sheet list.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "BranchId",
"in": "query",
"description": "An optional Branch Id. Used to filter the rate sheet list.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "ShiftId",
"in": "query",
"description": "An optional Shift Id. Used to filter the rate sheet list.",
"style": "form",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "IsActive",
"in": "query",
"description": "An optional parameter to indicate whether to return all, active, or inactive rate sheets.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "OrderBy",
"in": "query",
"description": "An optional parameter that will sort the query by the specified property.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "OrderByAscending",
"in": "query",
"description": "An optional parameter that will change whether the field the query is ordered by is ordered ascending or descending.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "Skip",
"in": "query",
"description": "The number of rate sheets to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Take",
"in": "query",
"description": "The number of rate sheets to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.RateSheets.Service.Commands.GetRateSheetList.Result, RateSheets.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.RateSheets.Service.Commands.GetRateSheetList.Result, RateSheets.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.RateSheets.Service.Commands.GetRateSheetList.Result, RateSheets.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.RateSheets.Service.Commands.GetRateSheetList.Result, RateSheets.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.RateSheets.Service.Commands.GetRateSheetList.Result, RateSheets.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.RateSheets.Service.Commands.GetRateSheetList.Result, RateSheets.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.RateSheets.Service.Commands.GetRateSheetList.Result, RateSheets.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"RateSheets"
],
"summary": "Create a new Rate Sheet",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): ratesheet-write ````",
"operationId": "RatesheetsPost",
"requestBody": {
"description": "The data needed for creating a Rate Sheet",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.RateSheets.API.Models.CreateRateSheetRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.RateSheets.API.Models.CreateRateSheetRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.RateSheets.API.Models.CreateRateSheetRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.RateSheets.API.Models.CreateRateSheetRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.RateSheets.API.Models.CreateRateSheetRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.RateSheets.API.Models.CreateRateSheetRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.RateSheets.API.Models.CreateRateSheetRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.RateSheets.API.Models.CreateRateSheetRequest"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.RateSheets.Service.Commands.CreateRateSheet.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.RateSheets.Service.Commands.CreateRateSheet.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.RateSheets.Service.Commands.CreateRateSheet.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.RateSheets.Service.Commands.CreateRateSheet.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.RateSheets.Service.Commands.CreateRateSheet.Result"
}
}
}
}
}
}
},
"/ratesheets/{id}/calculateGrossProfit": {
"post": {
"tags": [
"RateSheets"
],
"summary": "Calculate Gross Profit for a Rate Sheet",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): ratesheet-read or ratesheet-write ````",
"operationId": "RatesheetsByIdCalculateGrossProfitPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the Rate Sheet",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "Request Body",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.CalculateGrossProfitRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.CalculateGrossProfitRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.CalculateGrossProfitRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.CalculateGrossProfitRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.CalculateGrossProfitRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.CalculateGrossProfitRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.CalculateGrossProfitRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.CalculateGrossProfitRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.CalculateGrossProfitResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.CalculateGrossProfitResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.CalculateGrossProfitResult"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.CalculateGrossProfitResult"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.CalculateGrossProfitResult"
}
}
}
}
}
}
},
"/ratesheets/{rateSheetId}": {
"get": {
"tags": [
"RateSheets"
],
"summary": "Get a Specified Rate Sheet",
"description": "Get a Specified Rate Sheet.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): ratesheet-read or ratesheet-write ````",
"operationId": "RatesheetsByRateSheetIdGet",
"parameters": [
{
"name": "RateSheetId",
"in": "path",
"description": "A Rate Sheet Id that matches a specific rate sheet.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.RateSheets.Service.Commands.RateSheetDetailsQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.RateSheets.Service.Commands.RateSheetDetailsQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.RateSheets.Service.Commands.RateSheetDetailsQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.RateSheets.Service.Commands.RateSheetDetailsQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.RateSheets.Service.Commands.RateSheetDetailsQuery.Result"
}
}
}
}
}
},
"patch": {
"tags": [
"RateSheets"
],
"summary": "Patch Rate Sheet Information",
"description": "\r\n\r\n Allows for Json patching to be performed against basic contact fields.\r\n More information about PATCHING, see https://developer.ontempworks.com/docs/your-request\r\n \r\n\r\n\r\n Valid Patch paths: /EmployeeId(long?), /CustomerId(long?), /WorksiteId(int?), /JobTitleId(int?), /BranchId(int?), /ShiftId(Guid?), /WorkerCompCodeId(int?), /ApplyRateSheetToCustomerDepartments(bool?), /IsActive(bool)\r\n \n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): ratesheet-write ````",
"operationId": "RatesheetsByRateSheetIdPatch",
"parameters": [
{
"name": "rateSheetId",
"in": "path",
"description": "The Id of the RateSheet",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "A Json array of patch operations to be performed.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":1234,"path":"/CustomerId","op":"replace"},{"value":1234,"path":"/CustomerId","op":"add"},{"path":"/CustomerId","op":"remove"},{"path":"/IsActive","op":"copy","from":"/ApplyRateSheetToCustomerDepartments"},{"path":"/IsActive","op":"move","from":"/ApplyRateSheetToCustomerDepartments"},{"value":1234,"path":"/CustomerId","op":"test"}]
},
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":1234,"path":"/CustomerId","op":"replace"},{"value":1234,"path":"/CustomerId","op":"add"},{"path":"/CustomerId","op":"remove"},{"path":"/IsActive","op":"copy","from":"/ApplyRateSheetToCustomerDepartments"},{"path":"/IsActive","op":"move","from":"/ApplyRateSheetToCustomerDepartments"},{"value":1234,"path":"/CustomerId","op":"test"}]
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":1234,"path":"/CustomerId","op":"replace"},{"value":1234,"path":"/CustomerId","op":"add"},{"path":"/CustomerId","op":"remove"},{"path":"/IsActive","op":"copy","from":"/ApplyRateSheetToCustomerDepartments"},{"path":"/IsActive","op":"move","from":"/ApplyRateSheetToCustomerDepartments"},{"value":1234,"path":"/CustomerId","op":"test"}]
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":1234,"path":"/CustomerId","op":"replace"},{"value":1234,"path":"/CustomerId","op":"add"},{"path":"/CustomerId","op":"remove"},{"path":"/IsActive","op":"copy","from":"/ApplyRateSheetToCustomerDepartments"},{"path":"/IsActive","op":"move","from":"/ApplyRateSheetToCustomerDepartments"},{"value":1234,"path":"/CustomerId","op":"test"}]
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":1234,"path":"/CustomerId","op":"replace"},{"value":1234,"path":"/CustomerId","op":"add"},{"path":"/CustomerId","op":"remove"},{"path":"/IsActive","op":"copy","from":"/ApplyRateSheetToCustomerDepartments"},{"path":"/IsActive","op":"move","from":"/ApplyRateSheetToCustomerDepartments"},{"value":1234,"path":"/CustomerId","op":"test"}]
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": "\r\n \r\n \r\n replace\r\n /CustomerId\r\n 1234\r\n \r\n \r\n \r\n add\r\n /CustomerId\r\n 1234\r\n \r\n \r\n \r\n remove\r\n /CustomerId\r\n \r\n \r\n \r\n /ApplyRateSheetToCustomerDepartments\r\n copy\r\n /IsActive\r\n \r\n \r\n \r\n /ApplyRateSheetToCustomerDepartments\r\n move\r\n /IsActive\r\n \r\n \r\n \r\n \r\n test\r\n /CustomerId\r\n 1234\r\n \r\n"
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": "\r\n \r\n \r\n replace\r\n /CustomerId\r\n 1234\r\n \r\n \r\n \r\n add\r\n /CustomerId\r\n 1234\r\n \r\n \r\n \r\n remove\r\n /CustomerId\r\n \r\n \r\n \r\n /ApplyRateSheetToCustomerDepartments\r\n copy\r\n /IsActive\r\n \r\n \r\n \r\n /ApplyRateSheetToCustomerDepartments\r\n move\r\n /IsActive\r\n \r\n \r\n \r\n \r\n test\r\n /CustomerId\r\n 1234\r\n \r\n"
},
"application/*+xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": "\r\n \r\n \r\n replace\r\n /CustomerId\r\n 1234\r\n \r\n \r\n \r\n add\r\n /CustomerId\r\n 1234\r\n \r\n \r\n \r\n remove\r\n /CustomerId\r\n \r\n \r\n \r\n /ApplyRateSheetToCustomerDepartments\r\n copy\r\n /IsActive\r\n \r\n \r\n \r\n /ApplyRateSheetToCustomerDepartments\r\n move\r\n /IsActive\r\n \r\n \r\n \r\n \r\n test\r\n /CustomerId\r\n 1234\r\n \r\n"
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/ratesheets/{RateSheetId}": {
"put": {
"tags": [
"RateSheets"
],
"summary": "Update a Rate Sheet",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): ratesheet-write ````",
"operationId": "RatesheetsByRateSheetIdPut",
"parameters": [
{
"name": "RateSheetId",
"in": "path",
"description": "The Id of a specific Rate Sheet",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The data needed for updating a Rate Sheet",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.RateSheets.API.Models.UpdateRateSheetRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.RateSheets.API.Models.UpdateRateSheetRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.RateSheets.API.Models.UpdateRateSheetRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.RateSheets.API.Models.UpdateRateSheetRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.RateSheets.API.Models.UpdateRateSheetRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.RateSheets.API.Models.UpdateRateSheetRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.RateSheets.API.Models.UpdateRateSheetRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.RateSheets.API.Models.UpdateRateSheetRequest"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/ratesheets/matches": {
"get": {
"tags": [
"RateSheets"
],
"summary": "Gets a list of Rate Sheet Matches for a given criteria.",
"description": "Gets a list of Rate Sheet Matches for a given criteria.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): ratesheet-read or ratesheet-write ````",
"operationId": "RatesheetsMatchesGet",
"parameters": [
{
"name": "EmployeeId",
"in": "query",
"description": "An optional Employee Id. Used to filter the rate sheet list.",
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "CustomerId",
"in": "query",
"description": "An optional Customer Id. Used to filter the rate sheet list.",
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "WorksiteId",
"in": "query",
"description": "An optional Worksite Id. Used to filter the rate sheet list.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "JobTitleId",
"in": "query",
"description": "An optional Job Title Id. Used to filter the rate sheet list.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "BranchId",
"in": "query",
"description": "An optional Branch Id. Used to filter the rate sheet list.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "ShiftId",
"in": "query",
"description": "An optional Shift Id. Used to filter the rate sheet list.",
"style": "form",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.RateSheets.Service.Commands.GetRateSheetMatchList.Result, RateSheets.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.RateSheets.Service.Commands.GetRateSheetMatchList.Result, RateSheets.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.RateSheets.Service.Commands.GetRateSheetMatchList.Result, RateSheets.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.RateSheets.Service.Commands.GetRateSheetMatchList.Result, RateSheets.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.RateSheets.Service.Commands.GetRateSheetMatchList.Result, RateSheets.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.RateSheets.Service.Commands.GetRateSheetMatchList.Result, RateSheets.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.RateSheets.Service.Commands.GetRateSheetMatchList.Result, RateSheets.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Reports": {
"get": {
"tags": [
"Reports"
],
"summary": "Get Reports List",
"description": "Returns the list of reports visible to the current user. Which reports are available are determined by the user's role and hierarchy. The reports are orderd by Report then ReportGroup.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): report-read ````",
"operationId": "ReportsGet",
"parameters": [
{
"name": "productId",
"in": "query",
"description": "Used to filter the reports list so that only reports usable by the specified product are returned. ProductIds are 1 = Enterprise, 2 = Beyond, 4 = WebCenter",
"required": true,
"style": "form",
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Enums.Products"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "reportGroupId",
"in": "query",
"description": "An optional parameter. If specified, only reports within the specified group will be returned.",
"style": "form",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "filter",
"in": "query",
"description": "An optional parameter which will limit results to reports whose name or description contains the provided string.",
"style": "form",
"schema": {
"maxLength": 255,
"minLength": 0,
"type": "string"
}
},
{
"name": "originTypeId",
"in": "query",
"description": "An optional parameter. If specified, only reports relevant to the Origin Type with the provided id will be returned.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Reports.Service.Commands.ReportsQuery.Result, Reports.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Reports.Service.Commands.ReportsQuery.Result, Reports.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Reports.Service.Commands.ReportsQuery.Result, Reports.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Reports.Service.Commands.ReportsQuery.Result, Reports.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Reports.Service.Commands.ReportsQuery.Result, Reports.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Reports.Service.Commands.ReportsQuery.Result, Reports.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Reports.Service.Commands.ReportsQuery.Result, Reports.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Reports/{reportId}": {
"get": {
"tags": [
"Reports"
],
"summary": "Get Report",
"description": "Return information about the specified report.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): report-read ````",
"operationId": "ReportsByReportIdGet",
"parameters": [
{
"name": "reportId",
"in": "path",
"description": "The product the reports will be used for. This is used by the report",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "productId",
"in": "query",
"description": "Used to filter the reports list so that only reports usable by the specified product are returned. ProductIds are 1 = Enterprise, 2 = Beyond, 3 = WebCenter",
"required": true,
"style": "form",
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Enums.Products"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Reports.Service.Commands.ReportsQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Reports.Service.Commands.ReportsQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Reports.Service.Commands.ReportsQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Reports.Service.Commands.ReportsQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Reports.Service.Commands.ReportsQuery.Result"
}
}
}
}
}
}
},
"/Reports/favorites": {
"get": {
"tags": [
"Reports"
],
"summary": "Get Favorite Reports List",
"description": "Returns the list of favorite reports visible to the current user. Which reports are available are determined by the user's role and hierarchy. The reports are orderd by Report then ReportGroup.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): report-read ````",
"operationId": "ReportsFavoritesGet",
"parameters": [
{
"name": "productId",
"in": "query",
"description": "Used to filter the reports list so that only reports usable by the specified product are returned. ProductIds are 1 = Enterprise, 2 = Beyond, 3 = WebCenter",
"required": true,
"style": "form",
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Enums.Products"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "reportGroupId",
"in": "query",
"description": "An optional parameter. If specified, only reports within the specified group will be returned.",
"style": "form",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "filter",
"in": "query",
"description": "An optional parameter which will limit results to reports whose name or description contains the provided string.",
"style": "form",
"schema": {
"maxLength": 255,
"minLength": 0,
"type": "string"
}
},
{
"name": "originTypeId",
"in": "query",
"description": "An optional parameter. If specified, only reports relevant to the Origin Type with the provided id will be returned.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Reports.Service.Commands.ReportsQuery.Result, Reports.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Reports.Service.Commands.ReportsQuery.Result, Reports.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Reports.Service.Commands.ReportsQuery.Result, Reports.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Reports.Service.Commands.ReportsQuery.Result, Reports.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Reports.Service.Commands.ReportsQuery.Result, Reports.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Reports.Service.Commands.ReportsQuery.Result, Reports.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Reports.Service.Commands.ReportsQuery.Result, Reports.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Reports"
],
"summary": "Add Favorite Report",
"description": "Adds a report to the authenticated user's favorite reports list.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): report-read ````",
"operationId": "ReportsFavoritesPost",
"requestBody": {
"description": "The request body containing the new favorite report.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Reports.API.Models.CreateFavoriteReportRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Reports.API.Models.CreateFavoriteReportRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Reports.API.Models.CreateFavoriteReportRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Reports.API.Models.CreateFavoriteReportRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Reports.API.Models.CreateFavoriteReportRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Reports.API.Models.CreateFavoriteReportRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Reports.API.Models.CreateFavoriteReportRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Reports.API.Models.CreateFavoriteReportRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created"
}
}
}
},
"/Reports/favorites/{reportId}": {
"delete": {
"tags": [
"Reports"
],
"summary": "Delete Favorite Report",
"description": "Deletes a report from the authenticated user's favorite reports list.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): report-read ````",
"operationId": "ReportsFavoritesByReportIdDelete",
"parameters": [
{
"name": "reportId",
"in": "path",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Reports/kpiReports": {
"get": {
"tags": [
"Reports"
],
"summary": "Get Kpi Reports List",
"description": "Returns a list of Kpi Reports visible to the current user based on their hierarchy and security.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): report-read ````",
"operationId": "ReportsKpiReportsGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Reports.Service.Commands.KpiReports.Result, Reports.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Reports.Service.Commands.KpiReports.Result, Reports.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Reports.Service.Commands.KpiReports.Result, Reports.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Reports.Service.Commands.KpiReports.Result, Reports.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Reports.Service.Commands.KpiReports.Result, Reports.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Reports.Service.Commands.KpiReports.Result, Reports.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Reports.Service.Commands.KpiReports.Result, Reports.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Reports/kpiReports/{reportId}": {
"get": {
"tags": [
"Reports"
],
"summary": "Get Kpi Report Details",
"description": "Returns details about the specified Kpi Report\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): report-read ````",
"operationId": "ReportsKpiReportsByReportIdGet",
"parameters": [
{
"name": "reportId",
"in": "path",
"description": "The Id of the Kpi Report to get details about.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Reports.Service.Commands.KpiReports.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Reports.Service.Commands.KpiReports.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Reports.Service.Commands.KpiReports.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Reports.Service.Commands.KpiReports.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Reports.Service.Commands.KpiReports.Result"
}
}
}
}
}
}
},
"/Reports/kpiReports/{reportId}/parameters": {
"get": {
"tags": [
"Reports"
],
"summary": "Get Kpi Report Parameters",
"description": "Returns a list of paramaters used to execute the specified Kpi Report.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): report-read ````",
"operationId": "ReportsKpiReportsByReportIdParametersGet",
"parameters": [
{
"name": "reportId",
"in": "path",
"description": "The Id of the Kpi Report to get parameters for.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to take. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Reports.Service.Commands.KpiReportParameters.Result, Reports.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Reports.Service.Commands.KpiReportParameters.Result, Reports.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Reports.Service.Commands.KpiReportParameters.Result, Reports.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Reports.Service.Commands.KpiReportParameters.Result, Reports.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Reports.Service.Commands.KpiReportParameters.Result, Reports.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Reports.Service.Commands.KpiReportParameters.Result, Reports.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Reports.Service.Commands.KpiReportParameters.Result, Reports.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Reports/kpiReports/{reportId}/run": {
"post": {
"tags": [
"Reports"
],
"summary": "Run Kpi Report",
"description": "Returns the result of the Kpi Report based on the specified parameters.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): report-read ````",
"operationId": "ReportsKpiReportsByReportIdRunPost",
"parameters": [
{
"name": "reportId",
"in": "path",
"description": "The Id of the Kpi Report to run.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "A request body containing the parameters to use when running the Kpi Report.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Reports.Service.Models.RunKpiReportRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Reports.Service.Models.RunKpiReportRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Reports.Service.Models.RunKpiReportRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Reports.Service.Models.RunKpiReportRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Reports.Service.Models.RunKpiReportRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Reports.Service.Models.RunKpiReportRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Reports.Service.Models.RunKpiReportRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Reports.Service.Models.RunKpiReportRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Reports.Service.Commands.RunKpiReport.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Reports.Service.Commands.RunKpiReport.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Reports.Service.Commands.RunKpiReport.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Reports.Service.Commands.RunKpiReport.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Reports.Service.Commands.RunKpiReport.Result"
}
}
}
}
}
}
},
"/Reports/specialReports/{id}": {
"get": {
"tags": [
"Reports"
],
"summary": "Get Special Report",
"description": "Returns information about the special report with the supplied id.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "ReportsSpecialReportsByIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The special report id.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Reports.SpecialReportDetails.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Reports.SpecialReportDetails.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Reports.SpecialReportDetails.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Reports.SpecialReportDetails.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Reports.SpecialReportDetails.Result"
}
}
}
}
}
}
},
"/Search/{originTypeId}": {
"post": {
"tags": [
"Searches"
],
"summary": "Dynamic Search",
"description": "Searches through customers filtering by the provided criteria.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "SearchByOriginTypeIdPost",
"parameters": [
{
"name": "originTypeId",
"in": "path",
"description": "The origin type the search is looking for.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The request body containing the information about how to perform the search.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.API.Models.PerformDynamicSearchRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.API.Models.PerformDynamicSearchRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.API.Models.PerformDynamicSearchRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.API.Models.PerformDynamicSearchRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.API.Models.PerformDynamicSearchRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.API.Models.PerformDynamicSearchRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.API.Models.PerformDynamicSearchRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.API.Models.PerformDynamicSearchRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Models.DynamicSearchResults"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Models.DynamicSearchResults"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Models.DynamicSearchResults"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Models.DynamicSearchResults"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Models.DynamicSearchResults"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Models.DynamicSearchResults"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Models.DynamicSearchResults"
}
}
}
}
}
}
},
"/Search/{originTypeId}/Categories": {
"get": {
"tags": [
"Searches"
],
"summary": "Get Search Categories",
"description": "Returns a paged list of search categories ordered by the Category.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "SearchByOriginTypeIdCategoriesGet",
"parameters": [
{
"name": "originTypeId",
"in": "path",
"description": "The Id of the search origin type.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "categoryId",
"in": "query",
"description": "Optional filter on the Id of the category.",
"style": "form",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SearchCategoriesQuery.SearchCategory, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SearchCategoriesQuery.SearchCategory, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SearchCategoriesQuery.SearchCategory, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SearchCategoriesQuery.SearchCategory, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SearchCategoriesQuery.SearchCategory, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SearchCategoriesQuery.SearchCategory, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SearchCategoriesQuery.SearchCategory, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Search/{originTypeId}/Columns": {
"get": {
"tags": [
"Searches"
],
"summary": "Get Search Columns",
"description": "Returns a paged list of search columns ordered by the columnDisplayName.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "SearchByOriginTypeIdColumnsGet",
"parameters": [
{
"name": "originTypeId",
"in": "path",
"description": "The Id of the search origin type.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "categoryId",
"in": "query",
"description": "Optional filter on the Id of the search category.",
"style": "form",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "tableId",
"in": "query",
"description": "Optional filter on the Id of the search table.",
"style": "form",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "filter",
"in": "query",
"description": "Optional filter on the ColumnDisplayName.",
"style": "form",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Models.DynamicSearchColumn, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Models.DynamicSearchColumn, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Models.DynamicSearchColumn, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Models.DynamicSearchColumn, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Models.DynamicSearchColumn, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Models.DynamicSearchColumn, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Models.DynamicSearchColumn, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Search/{originTypeId}/history": {
"get": {
"tags": [
"Searches"
],
"summary": "Get Dynamic Search History",
"description": "Gets a list of the most recent dynamic searches run.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "SearchByOriginTypeIdHistoryGet",
"parameters": [
{
"name": "originTypeId",
"in": "path",
"description": "The origin type of the past searches.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SearchHistoryListQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SearchHistoryListQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SearchHistoryListQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SearchHistoryListQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SearchHistoryListQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SearchHistoryListQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SearchHistoryListQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Search/{originTypeId}/searches": {
"post": {
"tags": [
"Searches"
],
"summary": "Create Saved Searches",
"description": "Gets a list of saved searches for the specified origin type.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "SearchByOriginTypeIdSearchesPost",
"parameters": [
{
"name": "originTypeId",
"in": "path",
"description": "The origin type the search is looking for.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The body of the request containing the new search properties.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.API.Models.CreateDynamicSearchRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.API.Models.CreateDynamicSearchRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.API.Models.CreateDynamicSearchRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.API.Models.CreateDynamicSearchRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.API.Models.CreateDynamicSearchRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.API.Models.CreateDynamicSearchRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.API.Models.CreateDynamicSearchRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.API.Models.CreateDynamicSearchRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.Dynamic.SavedSearches.CreateSavedSearchCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.Dynamic.SavedSearches.CreateSavedSearchCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.Dynamic.SavedSearches.CreateSavedSearchCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.Dynamic.SavedSearches.CreateSavedSearchCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.Dynamic.SavedSearches.CreateSavedSearchCommand.Result"
}
}
}
}
}
},
"get": {
"tags": [
"Searches"
],
"summary": "Get Saved Searches",
"description": "Gets a list of saved searches for the specified origin type.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "SearchByOriginTypeIdSearchesGet",
"parameters": [
{
"name": "originTypeId",
"in": "path",
"description": "The origin type the search is looking for.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "filter",
"in": "query",
"description": "An optional parameter used to filter on searches by their name and/or description.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SavedSearches.SavedSearchListQuery.SavedSearch, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SavedSearches.SavedSearchListQuery.SavedSearch, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SavedSearches.SavedSearchListQuery.SavedSearch, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SavedSearches.SavedSearchListQuery.SavedSearch, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SavedSearches.SavedSearchListQuery.SavedSearch, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SavedSearches.SavedSearchListQuery.SavedSearch, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SavedSearches.SavedSearchListQuery.SavedSearch, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Search/{originTypeId}/searches/{savedSearchId}": {
"put": {
"tags": [
"Searches"
],
"summary": "Edit Saved Search",
"description": "Edits the specified saved search.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "SearchByOriginTypeIdSearchesBySavedSearchIdPut",
"parameters": [
{
"name": "originTypeId",
"in": "path",
"description": "The origin type the search is looking for.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "savedSearchId",
"in": "path",
"description": "The Id of the search to edit.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The body of the request containing the edited search properties.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.API.Models.UpdateDynamicSearchRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.API.Models.UpdateDynamicSearchRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.API.Models.UpdateDynamicSearchRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.API.Models.UpdateDynamicSearchRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.API.Models.UpdateDynamicSearchRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.API.Models.UpdateDynamicSearchRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.API.Models.UpdateDynamicSearchRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.API.Models.UpdateDynamicSearchRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
},
"delete": {
"tags": [
"Searches"
],
"summary": "Delete Saved Search",
"description": "Deletes the specified saved search.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "SearchByOriginTypeIdSearchesBySavedSearchIdDelete",
"parameters": [
{
"name": "originTypeId",
"in": "path",
"description": "The origin type the search is looking for.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "savedSearchId",
"in": "path",
"description": "The Id of the search to delete.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
},
"get": {
"tags": [
"Searches"
],
"summary": "Get Saved Search",
"description": "Gets the specified saved search.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "SearchByOriginTypeIdSearchesBySavedSearchIdGet",
"parameters": [
{
"name": "originTypeId",
"in": "path",
"description": "The origin type the search is looking for.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "savedSearchId",
"in": "path",
"description": "The id of the saved search.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.Dynamic.SavedSearches.SavedSearchListQuery.SavedSearch"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.Dynamic.SavedSearches.SavedSearchListQuery.SavedSearch"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.Dynamic.SavedSearches.SavedSearchListQuery.SavedSearch"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.Dynamic.SavedSearches.SavedSearchListQuery.SavedSearch"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.Dynamic.SavedSearches.SavedSearchListQuery.SavedSearch"
}
}
}
}
}
}
},
"/Search/{originTypeId}/searches/{savedSearchId}/teams": {
"get": {
"tags": [
"Searches"
],
"summary": "Get Saved Search Teams",
"description": "Gets a list of teams to which the saved search has been distributed.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "SearchByOriginTypeIdSearchesBySavedSearchIdTeamsGet",
"parameters": [
{
"name": "originTypeId",
"in": "path",
"description": "The origin type the search is looking for.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "savedSearchId",
"in": "path",
"description": "The Id of the search to edit.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SavedSearches.SavedSearchTeamList.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SavedSearches.SavedSearchTeamList.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SavedSearches.SavedSearchTeamList.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SavedSearches.SavedSearchTeamList.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SavedSearches.SavedSearchTeamList.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SavedSearches.SavedSearchTeamList.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SavedSearches.SavedSearchTeamList.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"put": {
"tags": [
"Searches"
],
"summary": "Edit Saved Search Teams",
"description": "Updates the teams to which the search has been distributed to the specified list.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "SearchByOriginTypeIdSearchesBySavedSearchIdTeamsPut",
"parameters": [
{
"name": "originTypeId",
"in": "path",
"description": "The origin type the search is looking for.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "savedSearchId",
"in": "path",
"description": "The Id of the search to edit.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The body of the request containing the new distribution list. A list of TeamIds can be found at Datalists/ServiceRepTeams",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.API.Models.EditDynamicSearchTeamsRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.API.Models.EditDynamicSearchTeamsRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.API.Models.EditDynamicSearchTeamsRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.API.Models.EditDynamicSearchTeamsRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.API.Models.EditDynamicSearchTeamsRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.API.Models.EditDynamicSearchTeamsRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.API.Models.EditDynamicSearchTeamsRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.API.Models.EditDynamicSearchTeamsRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Search/{originTypeId}/searches/default": {
"get": {
"tags": [
"Searches"
],
"summary": "Get Default Search",
"description": "Gets the default search for the specified origin type.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "SearchByOriginTypeIdSearchesDefaultGet",
"parameters": [
{
"name": "originTypeId",
"in": "path",
"description": "The origin type the search is looking for.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.Dynamic.SavedSearches.SavedSearchListQuery.SavedSearch"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.Dynamic.SavedSearches.SavedSearchListQuery.SavedSearch"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.Dynamic.SavedSearches.SavedSearchListQuery.SavedSearch"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.Dynamic.SavedSearches.SavedSearchListQuery.SavedSearch"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.Dynamic.SavedSearches.SavedSearchListQuery.SavedSearch"
}
}
}
}
}
}
},
"/Search/{originTypeId}/searches/favorites": {
"get": {
"tags": [
"Searches"
],
"summary": "Get Favorite Saved Searches",
"description": "Gets a list of favorite saved searches for the specified origin type.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "SearchByOriginTypeIdSearchesFavoritesGet",
"parameters": [
{
"name": "originTypeId",
"in": "path",
"description": "The origin type the search is looking for.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SavedSearches.SavedSearchListQuery.SavedSearch, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SavedSearches.SavedSearchListQuery.SavedSearch, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SavedSearches.SavedSearchListQuery.SavedSearch, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SavedSearches.SavedSearchListQuery.SavedSearch, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SavedSearches.SavedSearchListQuery.SavedSearch, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SavedSearches.SavedSearchListQuery.SavedSearch, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SavedSearches.SavedSearchListQuery.SavedSearch, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Searches"
],
"summary": "Add Favorite Saved Search",
"description": "Favorites a saved search for the origin type.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "SearchByOriginTypeIdSearchesFavoritesPost",
"parameters": [
{
"name": "originTypeId",
"in": "path",
"description": "The origin type the search is looking for.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The request body containing the id of the search to favorite",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.API.Models.AddFavoriteSavedSearchRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.API.Models.AddFavoriteSavedSearchRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.API.Models.AddFavoriteSavedSearchRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.API.Models.AddFavoriteSavedSearchRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.API.Models.AddFavoriteSavedSearchRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.API.Models.AddFavoriteSavedSearchRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.API.Models.AddFavoriteSavedSearchRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.API.Models.AddFavoriteSavedSearchRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created"
}
}
}
},
"/Search/{originTypeId}/searches/favorites/{savedSearchId}": {
"delete": {
"tags": [
"Searches"
],
"summary": "Remove Favorite Saved Search",
"description": "Removes a saved search from the user's list of favorites for the origin type.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "SearchByOriginTypeIdSearchesFavoritesBySavedSearchIdDelete",
"parameters": [
{
"name": "originTypeId",
"in": "path",
"description": "The origin type the search is looking for.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "savedSearchId",
"in": "path",
"description": "The Id of the saved search to remove as a favorite.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Search/Assignments": {
"get": {
"tags": [
"Searches"
],
"summary": "Search Assignments",
"description": "Searches through assignments filtering by the search string and returns some information about the matching assignments.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): assignment-read or assignment-write ````",
"operationId": "SearchAssignmentsGet",
"parameters": [
{
"name": "Skip",
"in": "query",
"description": "The number of assignments to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Take",
"in": "query",
"description": "The number of assignments to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "LastName",
"in": "query",
"description": "Searches for assignments having an employee with the last name matching the provided value.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "FirstName",
"in": "query",
"description": "Searches for assignments having an employee with the first name matching the provided value.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "CustomerName",
"in": "query",
"description": "Searches for assignments having a customer with the customer name matching the provided value.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "IsActive",
"in": "query",
"description": "Searches for assignments that are active or inactive based upon the provided value. Leave null to return all.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "AssignmentServiceRepId",
"in": "query",
"description": "Searches for assignments having specific a Service Rep Id. Valid Service Reps can be found in the ServiceRep datalist.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "BranchId",
"in": "query",
"description": "Searches for assignments having a branch with the branchId matching the provided value. Valid branches can be found in the Branch datalist.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "EmployeeId",
"in": "query",
"description": "Searches for assignments having an employee with the employeeId matching the provided value.",
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "AssignmentIds",
"in": "query",
"description": "Searches for assignments with the specified Ids.",
"style": "form",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
},
{
"name": "JobOrderId",
"in": "query",
"description": "Searches for assignments belonging to the specified Job Order.",
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "CustomerId",
"in": "query",
"description": "Searches for assignments belonging to job orders taken for the specified Customer.",
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "IsTimeclockOrder",
"in": "query",
"description": "Searches for assignments having an order enabled for timeclock.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "OrderBy",
"in": "query",
"description": "Used to order the results by one of the returned columns. The system sorts by employee last name by default.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "OrderByAscending",
"in": "query",
"description": "Used to specify the sort order. If left null, the system will order ascending automatically.",
"style": "form",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Assignments.AssignmentSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Assignments.AssignmentSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Assignments.AssignmentSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Assignments.AssignmentSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Assignments.AssignmentSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Assignments.AssignmentSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Assignments.AssignmentSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Search/BackgroundChecks": {
"post": {
"tags": [
"Searches"
],
"summary": "Background Check Search",
"description": "Returns a list of Background Checks Ordered by the Date Created Descending.",
"operationId": "SearchBackgroundChecksPost",
"requestBody": {
"description": "Criteria to be used in the Search",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.API.Models.BackgroundCheckSearchRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.API.Models.BackgroundCheckSearchRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.API.Models.BackgroundCheckSearchRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.API.Models.BackgroundCheckSearchRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.API.Models.BackgroundCheckSearchRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.API.Models.BackgroundCheckSearchRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.API.Models.BackgroundCheckSearchRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.API.Models.BackgroundCheckSearchRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.BackgroundChecks.BackgroundChecksSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.BackgroundChecks.BackgroundChecksSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.BackgroundChecks.BackgroundChecksSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.BackgroundChecks.BackgroundChecksSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.BackgroundChecks.BackgroundChecksSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.BackgroundChecks.BackgroundChecksSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.BackgroundChecks.BackgroundChecksSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Search/ColumnTypes": {
"get": {
"tags": [
"Searches"
],
"summary": "Get Search Column Types",
"description": "Returns a paged list of search column types ordered by the type column.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "SearchColumnTypesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SearchColumnTypeListQuery.SearchColumnType, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SearchColumnTypeListQuery.SearchColumnType, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SearchColumnTypeListQuery.SearchColumnType, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SearchColumnTypeListQuery.SearchColumnType, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SearchColumnTypeListQuery.SearchColumnType, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SearchColumnTypeListQuery.SearchColumnType, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SearchColumnTypeListQuery.SearchColumnType, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Search/Contacts": {
"get": {
"tags": [
"Searches"
],
"summary": "Contact Search",
"description": "Searches through contacts filtering by the provided criteria.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): contact-read or contact-write ````",
"operationId": "SearchContactsGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of contacts to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of contacts to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "lastName",
"in": "query",
"description": "Searches for contacts with a last name starting with the provided value",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "firstName",
"in": "query",
"description": "Searches for contacts with a first name starting with the provided value",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "contactId",
"in": "query",
"description": "Searches for contacts with an Id of the provided value",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "isActive",
"in": "query",
"description": "Used to control whether active, inactive, or all contacts are returned",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "customerId",
"in": "query",
"description": "Searches for contacts belonging to the customer with the provided Id",
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "customerName",
"in": "query",
"description": "Searches for contacts belonging to the customer with a name starting with the provided value",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "srIdent",
"in": "query",
"description": "Searches for contacts belonging to the provided service rep",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "branchId",
"in": "query",
"description": "Searches for contacts belonging to the provided branch. Valid branches can be found in the Branch datalist.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "orderBy",
"in": "query",
"description": "Used to order the results by one of the returned columns. The system sorts by contact name by default.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "orderByAscending",
"in": "query",
"description": "Used to specify the sort order. If left null, the system will order ascending automatically.",
"style": "form",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.ContactsSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.ContactsSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.ContactsSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.ContactsSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.ContactsSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.ContactsSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.ContactsSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Search/contracts": {
"get": {
"tags": [
"Searches"
],
"summary": "Contracts Search",
"description": "Searches through contracts filtering by the provided criteria.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): contract-read or contract-write ````",
"operationId": "SearchContractsGet",
"parameters": [
{
"name": "Skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Name",
"in": "query",
"description": "Searches for contracts with a last name starting with the provided value.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "PrimaryContactId",
"in": "query",
"description": "Searches for contracts with a primary contact matching the provided value.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "CustomerId",
"in": "query",
"description": "Searches for contracts with a primary contact matching the customer Id.",
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "CustomerName",
"in": "query",
"description": "Searches for contracts with a customer name starting with the provided value.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "Tag",
"in": "query",
"description": "Searches for contracts with a tag matching the provided value.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "IsActive",
"in": "query",
"description": "Searches for contracts which are active or inactive. Do not specify to return all.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "ContractStatusId",
"in": "query",
"description": "Searches for contracts with the status Id matching the provided value.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "ContractCategoryId",
"in": "query",
"description": ">Searches for contracts with a category matching the provided value.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "OwnedByServiceRepId",
"in": "query",
"description": "Searches for contracts which are owned by the specified Service Rep. A list of service reps can be found at the Service Reps Datalist.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "OrderBy",
"in": "query",
"description": "Used to order the results by one of the returned columns. The system sorts by name by default.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "OrderByAscending",
"in": "query",
"description": ">Used to specify the sort order. If left null, the system will order ascending automatically.",
"style": "form",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.ContractsSearch.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.ContractsSearch.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.ContractsSearch.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.ContractsSearch.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.ContractsSearch.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.ContractsSearch.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.ContractsSearch.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Search/CustomData/{originTypeId}": {
"get": {
"tags": [
"Searches"
],
"summary": "Custom Data Search",
"description": "Searches custom data across entities filtering by the provided criteria.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): universal-search ````",
"operationId": "SearchCustomDataByOriginTypeIdGet",
"parameters": [
{
"name": "originTypeId",
"in": "path",
"description": "Searches for values of properties for the specified origin type. Supported origin types:\r\nEmployee (1), Contact (3), Customer (2), Job Order (8), Assignment (14).",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "propertyDefinitionId",
"in": "query",
"description": "Searches for the property with the provided Id.",
"style": "form",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "propertyValue",
"in": "query",
"description": "Searches for properties with values including this string.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "includeInactiveProperties",
"in": "query",
"description": "Used to control whether inactive properties are returned.",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "skip",
"in": "query",
"description": "The number of records to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of records to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "orderBy",
"in": "query",
"description": "Used to order the results by one of the returned columns. The system sorts by category name and property name by default.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "orderByAscending",
"in": "query",
"description": "Used to specify the sort order. If left null, the system will order ascending automatically.",
"style": "form",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.CustomData.EntityCustomDataSearch.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.CustomData.EntityCustomDataSearch.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.CustomData.EntityCustomDataSearch.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.CustomData.EntityCustomDataSearch.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.CustomData.EntityCustomDataSearch.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.CustomData.EntityCustomDataSearch.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.CustomData.EntityCustomDataSearch.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Search/Customers": {
"get": {
"tags": [
"Searches"
],
"summary": "Customer Search",
"description": "Searches through customers filtering by the provided criteria.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): customer-read or customer-write ````",
"operationId": "SearchCustomersGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of customers to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of customers to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "customerName",
"in": "query",
"description": "Searches for customers with a name starting with the provided value",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "customerId",
"in": "query",
"description": "Searches for the customer with the provided Id",
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "isActive",
"in": "query",
"description": "Used to control whether active, inactive, or all customers are returned",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "includeDepartments",
"in": "query",
"description": "Used to control if customer departments are returned",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "srIdent",
"in": "query",
"description": "Searches for customers belonging to the provided service rep",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "branchId",
"in": "query",
"description": "Searches for customers belonging to the provided branch. Valid branches can be found in the Branch datalist.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "accountManagerServiceRepId",
"in": "query",
"description": "Searches for customers belonging to the provided account manager",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "orderBy",
"in": "query",
"description": "Used to order the results by one of the returned columns. The system sorts by customer name by default.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "orderByAscending",
"in": "query",
"description": "Used to specify the sort order. If left null, the system will order ascending automatically.",
"style": "form",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.CustomersSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.CustomersSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.CustomersSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.CustomersSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.CustomersSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.CustomersSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.CustomersSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Search/Datalists/{id}": {
"get": {
"tags": [
"Searches"
],
"summary": "Get Search Datalist",
"description": "Returns a paged list of key/value pairs.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "SearchDatalistsByIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the datalist to fetch.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "filter",
"in": "query",
"description": "Optional lookup on the Value of the results.",
"style": "form",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SearchDatalistQuery.DatalistItem, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SearchDatalistQuery.DatalistItem, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SearchDatalistQuery.DatalistItem, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SearchDatalistQuery.DatalistItem, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SearchDatalistQuery.DatalistItem, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SearchDatalistQuery.DatalistItem, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SearchDatalistQuery.DatalistItem, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Search/EmailAddress": {
"get": {
"tags": [
"Searches"
],
"summary": "Email Address Search",
"description": "Run a search which returns a list of email addresses for active employees, contacts and service representatives.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): email-read ````",
"operationId": "SearchEmailAddressGet",
"parameters": [
{
"name": "SearchString",
"in": "query",
"description": "The string used to search. Returns any matches on names or emails which start with the string provided.",
"required": true,
"style": "form",
"schema": {
"maxLength": 100,
"minLength": 3,
"type": "string"
}
},
{
"name": "OriginTypeFilter",
"in": "query",
"description": "Optional filter on the origin types. \r\nValid values are 1 - Employee, 2 - Customer, 3 - Contact, 18 - ServiceRep, 94 - Prospect, and 96 - ProspectContact.",
"style": "form",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
{
"name": "Skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer",
"format": "int32"
}
},
{
"name": "Take",
"in": "query",
"description": "The number of items to take. Used for paging.",
"style": "form",
"schema": {
"maximum": 2147483647,
"minimum": 1,
"type": "integer",
"format": "int32"
}
},
{
"name": "OrderBy",
"in": "query",
"description": "The column to order by. Use any column provided in the results.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "OrderByAscending",
"in": "query",
"description": "The OrderBy will be ascending when true. The default is true.",
"style": "form",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.EmailSearch.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.EmailSearch.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.EmailSearch.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.EmailSearch.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.EmailSearch.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.EmailSearch.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.EmailSearch.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Search/Employees": {
"get": {
"tags": [
"Searches"
],
"summary": "Employee Search",
"description": "Searches through employees filtering by the search string and returns some information about the matching employees.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "SearchEmployeesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of employees to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of employees to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "firstName",
"in": "query",
"description": "Searches for employees with a first name starting with the provided value",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "lastName",
"in": "query",
"description": "Searches for employees with a last name starting with the provided value",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "governmentPersonalId",
"in": "query",
"description": "Searches for employees with the provided government personal identifier",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "employeeId",
"in": "query",
"description": "Searches for employees with the provided Id",
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "isAssigned",
"in": "query",
"description": "Used to control whether assigned, unassigned, or all employees are returned",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "isActive",
"in": "query",
"description": "Used to control whether active, inactive, or all employees are returned",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "srIdent",
"in": "query",
"description": "Searches for employees belonging to the provided service rep",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "branchId",
"in": "query",
"description": "Searches for employees belonging to the provided branch. Valid branches can be found in the Branch datalist.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "orderBy",
"in": "query",
"description": "Used to order the results by one of the returned columns. The system sorts by employee last name by default.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "orderByAscending",
"in": "query",
"description": "Used to specify the sort order. If left null, the system will order ascending automatically.",
"style": "form",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.EmployeesSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.EmployeesSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.EmployeesSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.EmployeesSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.EmployeesSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.EmployeesSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.EmployeesSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Search/Employees/Interviews": {
"get": {
"tags": [
"Searches"
],
"summary": "Employee Interview Search",
"description": "Searches through employee interview answers, returning information about the matching interview answers and the employee who answered them, grouped/paged by employee.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "SearchEmployeesInterviewsGet",
"parameters": [
{
"name": "categoryId",
"in": "query",
"description": "If not null, restricts search to answers that belong to a particular interview question category.",
"style": "form",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "questionId",
"in": "query",
"description": "If not null, restricts search to answers that belong to a particular interview question.",
"style": "form",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "question",
"in": "query",
"description": "If not null or empty, restricts results to questions that contain the provided string (case insensitive).",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "answer",
"in": "query",
"description": "If not null or empty, restricts results to answers that contain the provided string (case insensitive).",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "interviewStartDate",
"in": "query",
"description": "If not null, restricts search to interviews that were assigned, modified, or completed after a particular date.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "interviewEndDate",
"in": "query",
"description": "If not null, restricts search to interviews that were assigned, modified, or completed before a particular date.",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "employeeIsActive",
"in": "query",
"description": "If not null, restricts search to employees with a particular active status.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "employeeStatusId",
"in": "query",
"description": "If not null, restricts search to employees matching a particular status type. Valid statuses can be found in the EmployeeStatuses datalist.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "interviewName",
"in": "query",
"description": "If not null, restricts search to employees matching a particular interview name.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "orderBy",
"in": "query",
"description": "Used to order the results by one of the returned columns. The system sorts by employee last name by default.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "orderByAscending",
"in": "query",
"description": "Required. Used to specify the sort order.",
"style": "form",
"schema": {
"type": "boolean",
"default": true
}
},
{
"name": "skip",
"in": "query",
"description": "The number of employees to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of employees to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.EmployeesSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.EmployeesSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.EmployeesSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.EmployeesSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.EmployeesSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.EmployeesSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.EmployeesSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Search/Employees/RequiredDocuments": {
"get": {
"tags": [
"Searches"
],
"summary": "Employees Required Documents Search",
"description": "Searches through employee missing, expired or soon expiring required documents, returning information about the matching documents \r\n and the employees who own them, grouped/paged by employees.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "SearchEmployeesRequiredDocumentsGet",
"parameters": [
{
"name": "BranchId",
"in": "query",
"description": "The optional branch identifier to filter by.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "DaysBeforeExpire",
"in": "query",
"description": "The optional number of days before expire to filter by, starting from today.",
"style": "form",
"schema": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer",
"format": "int32"
}
},
{
"name": "RequiredDocumentTypeId",
"in": "query",
"description": "The optional required document type identifier to filter by.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "RequiredDocumentTypeCategoryId",
"in": "query",
"description": "The optional required document type category identifier to filter by.",
"style": "form",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "RequiredDocumentStatusId",
"in": "query",
"description": "The optional required document type status identifier to filter by.",
"style": "form",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "FilterByStatus",
"in": "query",
"description": "The required document status to filter by.",
"style": "form",
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Enums.FilterByStatusType"
}
},
{
"name": "OrderBy",
"in": "query",
"description": "The employee column to order by. Default is LastName. \r\nValid options: LastName, FirstName, EmployeeId, BranchName, IsActive, HireStatus, RequiredDocuments",
"style": "form",
"schema": {
"maxLength": 50,
"minLength": 0,
"type": "string"
}
},
{
"name": "OrderByAscending",
"in": "query",
"description": "A value representing whether or not to order the chosen employee column data by ascending.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "Skip",
"in": "query",
"description": "The employees to skip for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Take",
"in": "query",
"description": "The employees to take for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Models.EmployeeRequiredDocumentSearchResult, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Models.EmployeeRequiredDocumentSearchResult, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Models.EmployeeRequiredDocumentSearchResult, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Models.EmployeeRequiredDocumentSearchResult, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Models.EmployeeRequiredDocumentSearchResult, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Models.EmployeeRequiredDocumentSearchResult, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Models.EmployeeRequiredDocumentSearchResult, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Search/Everify/Cases": {
"get": {
"tags": [
"Searches"
],
"summary": "E-Verify Case Search",
"description": "Searches through employees E-Verify Cases\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): everify-read or everify-write ````",
"operationId": "SearchEverifyCasesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "firstName",
"in": "query",
"description": "Searches for employees with a first name starting with the provided value.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "lastName",
"in": "query",
"description": "Searches for employees with a last name starting with the provided value.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "caseNumber",
"in": "query",
"description": "Searches for cases with a case number containing the provided value.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "employeeId",
"in": "query",
"description": "Searches for an employee with an employeeId that matches the provided value.",
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "isOpen",
"in": "query",
"description": "Used to control whether open, closed, or all cases are returned.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "eligibilityStatement",
"in": "query",
"description": "Searches for cases matching the provided eligibility statement.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "eligibilityStatementCode",
"in": "query",
"description": "Searches for cases matching the provided eligibility statement code. Valid values can be found at",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "caseId",
"in": "query",
"description": "Searches for cases matching the provided case Id.",
"style": "form",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "serviceRepId",
"in": "query",
"description": "Searches for employees belonging to the provided service rep",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "branchId",
"in": "query",
"description": "Searches for employees belonging to the provided branch. Valid branches can be found in the Branch datalist.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "orderBy",
"in": "query",
"description": "Used to order the results by one of the returned columns. The system sorts by employee last name by default.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "orderByAscending",
"in": "query",
"description": "Used to specify the sort order. If left null, the system will order ascending automatically.",
"style": "form",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.EverifyCasesSearchQuery.Response, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.EverifyCasesSearchQuery.Response, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.EverifyCasesSearchQuery.Response, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.EverifyCasesSearchQuery.Response, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.EverifyCasesSearchQuery.Response, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.EverifyCasesSearchQuery.Response, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.EverifyCasesSearchQuery.Response, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Search/Everify/Cases/EligibilityStatements": {
"get": {
"tags": [
"Searches"
],
"summary": "E-Verify Case EligibilityStatements Datalist",
"description": "Returns valid Eligibility Statements from current cases which can be used in the E-Verify Case Search.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): everify-read or everify-write ````",
"operationId": "SearchEverifyCasesEligibilityStatementsGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.EverifySearchEligibilityStatementDatalistQuery.Response, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.EverifySearchEligibilityStatementDatalistQuery.Response, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.EverifySearchEligibilityStatementDatalistQuery.Response, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.EverifySearchEligibilityStatementDatalistQuery.Response, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.EverifySearchEligibilityStatementDatalistQuery.Response, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.EverifySearchEligibilityStatementDatalistQuery.Response, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.EverifySearchEligibilityStatementDatalistQuery.Response, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Search/history": {
"get": {
"tags": [
"Searches"
],
"summary": "Get Dynamic Search History",
"description": "Gets a list of the most recent dynamic searches run.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "SearchHistoryGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SearchHistoryListQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SearchHistoryListQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SearchHistoryListQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SearchHistoryListQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SearchHistoryListQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SearchHistoryListQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SearchHistoryListQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Search/history/{id}": {
"get": {
"tags": [
"Searches"
],
"summary": "Get Dynamic Search History",
"description": "Gets a dynamic search history.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "SearchHistoryByIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the search history.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.Dynamic.SearchHistoryListQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.Dynamic.SearchHistoryListQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.Dynamic.SearchHistoryListQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.Dynamic.SearchHistoryListQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.Dynamic.SearchHistoryListQuery.Result"
}
}
}
}
}
}
},
"/Search/HrCenter/{productInstanceId}": {
"get": {
"tags": [
"Searches"
],
"summary": "HRCenter Search",
"description": "Searches through HRCenter Steps assigned to Employees.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): onboarding-read or onboarding-write ````",
"operationId": "SearchHrCenterByProductInstanceIdGet",
"parameters": [
{
"name": "productInstanceId",
"in": "path",
"description": "The HRCenter product instance Id of the tenant you are searching in. Valid Product Instances can be found in the HRCenter Product Instances Datalist.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "EmployeeId",
"in": "query",
"description": "An optional parameter. Filters the list to only steps belonging to the specified employee.",
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "EmployeeLastName",
"in": "query",
"description": "An optional parameter. Filters the list to only steps belonging to employees with a last name starting with the provided value.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "EmployeeFirstName",
"in": "query",
"description": "An optional parameter. Filters the list to only steps belonging to employees with a first name starting with the provided value.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "BranchId",
"in": "query",
"description": "An optional parameter. Filters the list to only steps belonging to employees at the specified branch. Valid branches can be found in the Branches Datalist.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "EmployeeGovernmentPersonalId",
"in": "query",
"description": "An optional parameter. Filters the list to only steps belonging to employees with a government personal identifier starting with the provided value.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "Username",
"in": "query",
"description": "An optional parameter. Filters the list to only steps belonging to employees with a username starting with the provided value.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "WorkflowId",
"in": "query",
"description": "An optional parameter. Filters the list to only steps belonging to the specified workflow. Valid Workflows can be found in the HRCenter Workflows Datalist.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "StepId",
"in": "query",
"description": "An optional parameter. Filters the list to only the specified step. Valid Steps can be found in the HRCenter Steps Datalist.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "StepStatus",
"in": "query",
"description": "An optional parameter. Filters the list to only steps with the specified status. Valid Step Statuses can be found in the HRCenter Step Statuses Datalist.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "IsEmployeeActive",
"in": "query",
"description": "An optional parameter. Filters the list to only steps belonging to employees who are or are not active.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "IsStepCurrent",
"in": "query",
"description": "An optional parameter. Filters the list to only steps that are or are not the currently active step in their workflow.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "AssignedByServiceRepId",
"in": "query",
"description": "An optional parameter. Filters the list to only steps belonging to workflows assigned by specified service rep.",
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "IncludeRejectedWorkflows",
"in": "query",
"description": "When true, steps belonging to rejected workflows are included in the results. By default, rejected workflows are excluded.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "OrderBy",
"in": "query",
"description": "Used to order the results by one of the returned columns. The system sorts by employee last name by default.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "OrderByAscending",
"in": "query",
"description": "Used to specify the sort order. If left null, the system will order ascending automatically.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "Skip",
"in": "query",
"description": "The number of customers to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Take",
"in": "query",
"description": "The number of customers to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.HrCenterSearchQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.HrCenterSearchQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.HrCenterSearchQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.HrCenterSearchQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.HrCenterSearchQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.HrCenterSearchQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.HrCenterSearchQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Search/JobBoard": {
"get": {
"tags": [
"Searches"
],
"summary": "Job Board Search",
"description": "Searches through job orders filtering by request parameters and returns some information about the matching job orders.\n \n```` Allows roles: ServiceRep, WebUserEmployee, Service ````\n \n```` Requires scope(s): jobboard-read or jobboard-write ````",
"operationId": "SearchJobBoardGet",
"parameters": [
{
"name": "sortBy",
"in": "query",
"description": "1 = Term Relativity Ranking, 2 = Job Title, 3 = Distance, 4 = Job Order Created",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "countryCode",
"in": "query",
"description": "The country code to match. Valid country codes can be found in the Countries datalist.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "textSearch",
"in": "query",
"description": "Text to match within the job posting. This includes the description, skills, and job title.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "postalCode",
"in": "query",
"description": "The postal code to use as the central point for a distance search. Requires distanceUnitId and distance also be provided.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "municipality",
"in": "query",
"description": "The municipality to match.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "region",
"in": "query",
"description": "The region to match. Valid regions can be found in the Regions datalist.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "latitude",
"in": "query",
"description": "The latitude used for the center of the distance search (decimal notation). Requires longitude, distance, and distanceUnitId.",
"style": "form",
"schema": {
"type": "number",
"format": "double"
}
},
{
"name": "longitude",
"in": "query",
"description": "The longitude used for the center of the distance search (decimal notation). Requires longitude, distance, and distanceUnitId.",
"style": "form",
"schema": {
"type": "number",
"format": "double"
}
},
{
"name": "distance",
"in": "query",
"description": "The distance to search from the postal code or latitude and longitude center. Requires distanceUnitId and either both longitude and latitude or postalCode.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "distanceUnitId",
"in": "query",
"description": "The units of the distance provided and returned. Valid values can be found at the Distance Units datalist. Requires distance and either both longitude and latitude or postalCode.",
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "culture",
"in": "query",
"description": "The culture to return the jobs.",
"style": "form",
"schema": {
"maxLength": 20,
"type": "string"
}
},
{
"name": "payRateMin",
"in": "query",
"description": "The minimum Pay Rate for the position.",
"style": "form",
"schema": {
"type": "number",
"format": "double"
}
},
{
"name": "payRateMax",
"in": "query",
"description": "The maximum Pay Rate for the position.",
"style": "form",
"schema": {
"type": "number",
"format": "double"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.JobBoardSearch.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.JobBoardSearch.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.JobBoardSearch.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.JobBoardSearch.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.JobBoardSearch.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.JobBoardSearch.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.JobBoardSearch.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Search/JobFeed": {
"get": {
"tags": [
"Searches"
],
"summary": "Job Feed Jobs",
"description": "Returns all orders that qualify for Job Feed display and information about them. User configuration setup will impact data returned\n \n```` Allows roles: ServiceRep, WebUserEmployee, Service ````\n \n```` Requires scope(s): jobboard-read or jobboard-write ````",
"operationId": "SearchJobFeedGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "culture",
"in": "query",
"description": "The culture to return the jobs.",
"style": "form",
"schema": {
"maxLength": 20,
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.JobFeedGetJobs.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.JobFeedGetJobs.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.JobFeedGetJobs.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.JobFeedGetJobs.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.JobFeedGetJobs.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.JobFeedGetJobs.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.JobFeedGetJobs.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Search/JobOrderCandidates": {
"post": {
"tags": [
"Searches"
],
"summary": "Search Candidates in all visible Job Orders",
"description": "Retrieves the list of candidates for all visible job orders.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): ordercandidate-read or ordercandidate-write ````",
"operationId": "SearchJobOrderCandidatesPost",
"requestBody": {
"description": "A request with filter and sort parameters.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.SearchMultipleJobOrdersCandidatesRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.SearchMultipleJobOrdersCandidatesRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.SearchMultipleJobOrdersCandidatesRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.SearchMultipleJobOrdersCandidatesRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.SearchMultipleJobOrdersCandidatesRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.SearchMultipleJobOrdersCandidatesRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.SearchMultipleJobOrdersCandidatesRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.API.Models.SearchMultipleJobOrdersCandidatesRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.MultipleJobOrdersCandidatesQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.MultipleJobOrdersCandidatesQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.MultipleJobOrdersCandidatesQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.MultipleJobOrdersCandidatesQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.MultipleJobOrdersCandidatesQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.MultipleJobOrdersCandidatesQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.MultipleJobOrdersCandidatesQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Search/JobOrders": {
"get": {
"tags": [
"Searches"
],
"summary": "JobOrder Search",
"description": "Searches through job orders filtering by the provided criteria.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): order-read or order-write ````",
"operationId": "SearchJobOrdersGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of job orders to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of job orders to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "customerName",
"in": "query",
"description": "Searches for job orders belonging to customers with a name starting with the provided value",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "orderId",
"in": "query",
"description": "Searches for the job order with the provided Id",
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "isFilled",
"in": "query",
"description": "Used to control whether filled, unfilled, or all job orders are returned",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "isActive",
"in": "query",
"description": "Used to control whether active, inactive, or all job orders are returned",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "srIdent",
"in": "query",
"description": "Searches for job orders belonging to the provided service rep",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "worksiteId",
"in": "query",
"description": "Searches for job orders linked to the provided worksite",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "branchId",
"in": "query",
"description": "Searches for job orders belonging to the provided branch. Valid branches can be found in the Branch datalist.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "orderBy",
"in": "query",
"description": "Used to order the results by one of the returned columns. The system sorts by order Id descending by default.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "orderByAscending",
"in": "query",
"description": "Used to specify the sort order. If left null, the system will order ascending automatically (see orderBy for the one exception).",
"style": "form",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.JobOrdersSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.JobOrdersSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.JobOrdersSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.JobOrdersSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.JobOrdersSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.JobOrdersSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.JobOrdersSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Search/Jobs": {
"get": {
"tags": [
"Searches"
],
"summary": "Job Board Search",
"description": "Searches through job orders filtering by request parameters and returns some information about the matching job orders.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): jobboard-read or jobboard-write ````",
"operationId": "SearchJobsGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "sortBy",
"in": "query",
"description": "1 = Term Relativity Ranking, 2 = Job Title, 3 = Distance, 4 = Job Order Created",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "countryCode",
"in": "query",
"description": "The country code to match. Valid country codes can be found in the Countries datalist.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "textSearch",
"in": "query",
"description": "Text to match within the public job order description",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "postalCode",
"in": "query",
"description": "The postal code to match",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "municipality",
"in": "query",
"description": "The municipality to match",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "region",
"in": "query",
"description": "The region to match. Valid regions can be found in the Regions datalist.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "latitude",
"in": "query",
"description": "The latitude used for the center of the distance search (decimal notation)",
"style": "form",
"schema": {
"type": "number",
"format": "double"
}
},
{
"name": "longitude",
"in": "query",
"description": "The longitude used for the center of the distance search (decimal notation)",
"style": "form",
"schema": {
"type": "number",
"format": "double"
}
},
{
"name": "distance",
"in": "query",
"description": "The distance, in miles, to search from the latitude and longitude center",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.JobsSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.JobsSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.JobsSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.JobsSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.JobsSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.JobsSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.JobsSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Search/NearMe/Customers": {
"get": {
"tags": [
"Searches"
],
"summary": "Customer Near Me Search",
"description": "Searches through employees filtering by the search string and returns some information about the matching employees.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "SearchNearMeCustomersGet",
"parameters": [
{
"name": "includeCustomersInResults",
"in": "query",
"description": "If set to true, customers will come back on the result object.",
"style": "form",
"schema": {
"type": "boolean",
"default": true
}
},
{
"name": "includeWorksitesInResults",
"in": "query",
"description": "If set to true, worksites will come back on the result object.",
"style": "form",
"schema": {
"type": "boolean",
"default": true
}
},
{
"name": "includeContactsInResults",
"in": "query",
"description": "If set to true, contacts will come back on the result object.",
"style": "form",
"schema": {
"type": "boolean",
"default": true
}
},
{
"name": "distanceUnitId",
"in": "query",
"description": "The units of the distance provided and returned. Valid values can be found at the Distance Units datalist. Requires distance and either both longitude and latitude or postalCode.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "distance",
"in": "query",
"description": "The distance to search from the postal code or latitude and longitude center. Requires distanceUnitId and either both longitude and latitude or postalCode.",
"required": true,
"style": "form",
"schema": {
"type": "number",
"format": "double"
}
},
{
"name": "latitude",
"in": "query",
"description": "The latitude used for the center of the distance search (decimal notation). Requires longitude. Cannot be used with address.",
"style": "form",
"schema": {
"type": "number",
"format": "double"
}
},
{
"name": "longitude",
"in": "query",
"description": "The longitude used for the center of the distance search (decimal notation). Requires latitude. Cannot be used with address.",
"style": "form",
"schema": {
"type": "number",
"format": "double"
}
},
{
"name": "address",
"in": "query",
"description": "The address used for the center of the distance search. Cannot be used with longitude and latitude.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "customerAccountManagerServiceRepId",
"in": "query",
"description": "Limits results to those associated with customers with the provided account manager. A list of service reps can be found at the Service Reps Datalist.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "customerStatusId",
"in": "query",
"description": "Limits results to those associated with customers with the provided status. A list of customer statuses can be found at the Customer Statuses Datalist.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "customerSalesPipelineStatusId",
"in": "query",
"description": "Limits results to those associated with customers with the provided sales pipeline status. A list of sales pipeline status can be found at the Sales Pipeline Statuses Datalist.",
"style": "form",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.NearMe.CustomerRelatedNearMeSearch.Results"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.NearMe.CustomerRelatedNearMeSearch.Results"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.NearMe.CustomerRelatedNearMeSearch.Results"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.NearMe.CustomerRelatedNearMeSearch.Results"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.NearMe.CustomerRelatedNearMeSearch.Results"
}
}
}
}
}
}
},
"/Search/Operators": {
"get": {
"tags": [
"Searches"
],
"summary": "Get Search Operators",
"description": "Returns a paged list of search operators ordered by the operator Id.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "SearchOperatorsGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Models.DynamicSearchOperator, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Models.DynamicSearchOperator, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Models.DynamicSearchOperator, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Models.DynamicSearchOperator, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Models.DynamicSearchOperator, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Models.DynamicSearchOperator, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Models.DynamicSearchOperator, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Search/prospects": {
"get": {
"tags": [
"Searches"
],
"summary": "Prospect Search",
"description": "Searches through contacts filtering by the provided criteria.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): prospect-read or prospect-write ````",
"operationId": "SearchProspectsGet",
"parameters": [
{
"name": "Skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Name",
"in": "query",
"description": "Searches for prospects with a name starting with the provided value.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "Department",
"in": "query",
"description": "Searches for prospects with a department starting with the provided value.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "ProspectStatusId",
"in": "query",
"description": "Searches for prospects with a ProspectStatusId that equals the provided value.",
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "ProspectContactName",
"in": "query",
"description": "Searches for prospects with a contact whose first name and/or last name matches the provided value.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "PhoneNumber",
"in": "query",
"description": "Searches for prospects with a Phone Number starting with the provided value or a prospect contact with a Phone Number\r\nstarting with the provided value.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "EmailAddress",
"in": "query",
"description": "Searches for prospects with an Email Address starting with the provided value or a prospect contact with an Email\r\nAddress starting with the provided value.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "OwnedByServiceRepId",
"in": "query",
"description": "Searches for prospects which are owned by the specified Service Rep. A list of service reps can be found at the\r\nService Reps Datalist.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "OrderBy",
"in": "query",
"description": "Used to order the results by one of the returned columns. The system sorts by name by default.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "OrderByAscending",
"in": "query",
"description": "Used to specify the sort order. If left null, the system will order ascending automatically.",
"style": "form",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.ProspectSearch.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.ProspectSearch.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.ProspectSearch.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.ProspectSearch.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.ProspectSearch.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.ProspectSearch.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.ProspectSearch.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
},
"deprecated": true
}
},
"/Search/Universal": {
"get": {
"tags": [
"Searches"
],
"summary": "Search Primary Origin Types",
"description": "Runs a text based search on employees, customers, contacts, job orders and assignments using the string value supplied.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): universal-search ````",
"operationId": "SearchUniversalGet",
"parameters": [
{
"name": "searchString",
"in": "query",
"description": "The value to search on",
"required": true,
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "originTypeId",
"in": "query",
"description": "Optional parameter to filter the search to a specific OriginType. e.g. Employee, Customer, etc.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 31
}
},
{
"name": "includeInactiveContactMethods",
"in": "query",
"description": "Optional parameter include inactive contact methods. The default value is false.",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.UniversalSearchQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.UniversalSearchQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.UniversalSearchQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.UniversalSearchQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.UniversalSearchQuery.Result"
}
}
}
}
}
}
},
"/Search/UniversalEmail": {
"get": {
"tags": [
"Searches"
],
"summary": "Search Primary Origin Types By Email Address",
"description": "Searches for employees, customers, and contacts with the specified email address on their records.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): universal-search ````",
"operationId": "SearchUniversalEmailGet",
"parameters": [
{
"name": "emailAddress",
"in": "query",
"description": "The email address to search for.",
"required": true,
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "includeInactiveContactMethods",
"in": "query",
"description": "Optional parameter include inactive contact methods. The default value is false.",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.UniversalEmailSearch.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.UniversalEmailSearch.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.UniversalEmailSearch.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.UniversalEmailSearch.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.UniversalEmailSearch.Result"
}
}
}
}
}
}
},
"/Search/UniversalPhone": {
"get": {
"tags": [
"Searches"
],
"summary": "Search Primary Origin Types By Phone Number",
"description": "Searches for employees, customers, and contacts with the specified phone number on their records.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): universal-search ````",
"operationId": "SearchUniversalPhoneGet",
"parameters": [
{
"name": "phone",
"in": "query",
"description": "The phone number to search for.",
"required": true,
"style": "form",
"schema": {
"maxLength": 30,
"minLength": 7,
"type": "string"
}
},
{
"name": "countryCode",
"in": "query",
"description": "An optional parameter specifying the country code of the phone number being searched for.",
"style": "form",
"schema": {
"maxLength": 10,
"minLength": 1,
"type": "string"
}
},
{
"name": "originTypeId",
"in": "query",
"description": "Optional parameter to filter the search to specific OriginTypes bitwise. e.g. Employee (1), Customer (2), Employee and Customer (3) Contact (4), etc.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 31
}
},
{
"name": "includeInactiveContactMethods",
"in": "query",
"description": "Optional parameter include inactive contact methods. The default value is false.",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.UniversalPhoneSearch.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.UniversalPhoneSearch.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.UniversalPhoneSearch.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.UniversalPhoneSearch.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.UniversalPhoneSearch.Result"
}
}
}
}
}
}
},
"/Search/Vendors": {
"get": {
"tags": [
"Searches"
],
"summary": "Vendor Search",
"description": "Searches through vendors filtering by the search string and returns some information about the matching vendors.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): vendor-read ````",
"operationId": "SearchVendorsGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of vendors to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of vendors to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "vendorId",
"in": "query",
"description": "Searches for vendors with the provided Id.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "vendorName",
"in": "query",
"description": "Searches for vendors with a vendor name starting with the provided value.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "isActive",
"in": "query",
"description": "Searches for vendors with the provided active status.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "orderBy",
"in": "query",
"description": "Used to order the results by one of the returned columns. The system sorts by vendor name by default.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "orderByAscending",
"in": "query",
"description": "Used to specify the sort order. If left null, the system will order ascending automatically.",
"style": "form",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.VendorsSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.VendorsSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.VendorsSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.VendorsSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.VendorsSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.VendorsSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.VendorsSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Search/WebUsers": {
"get": {
"tags": [
"Searches"
],
"summary": "WebUser Search",
"description": "Searches through WebUsers filtering by request parameters and returns some information about the matching WebUsers.\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): webuser-read or webuser-write ````",
"operationId": "SearchWebUsersGet",
"parameters": [
{
"name": "username",
"in": "query",
"description": "The username of the Web User.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "emailAddress",
"in": "query",
"description": "The email address of the Web User.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "firstName",
"in": "query",
"description": "The first name of the Web User.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "lastName",
"in": "query",
"description": "The last name of the Web User.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "restrictToProductInstanceId",
"in": "query",
"description": "Restricts results to entities linked to a specific product instance.",
"style": "form",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "includeEntitiesWithoutAccounts",
"in": "query",
"description": "Defaults to false. If set to true, those entities without web user records will be included in the results.",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "skip",
"in": "query",
"description": "The number of assignments to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of assignments to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.WebUsersSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.WebUsersSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.WebUsersSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.WebUsersSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.WebUsersSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.WebUsersSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.WebUsersSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/SecurityGroups": {
"get": {
"tags": [
"SecurityGroups"
],
"summary": "Get Security Group List",
"description": "Returns a list of the available user security groups in the system ordered by name.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "SecurityGroupsGet",
"parameters": [
{
"name": "hierId",
"in": "query",
"description": "Get security groups visible at a particular hierarchy",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "securityGroupTypeId",
"in": "query",
"description": "Optional security group type ID",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"SecurityGroups"
],
"summary": "Create Security Group",
"description": "Creates a new security group.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): securitygroup-write ````",
"operationId": "SecurityGroupsPost",
"requestBody": {
"description": "The security group to create",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupRequest"
}
}
}
},
"responses": {
"201": {
"description": "Security Group created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.SecurityGroups.CreateSecurityGroupCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.SecurityGroups.CreateSecurityGroupCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.SecurityGroups.CreateSecurityGroupCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.SecurityGroups.CreateSecurityGroupCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.SecurityGroups.CreateSecurityGroupCommand.Result"
}
}
}
}
}
}
},
"/SecurityGroups/{id}": {
"get": {
"tags": [
"SecurityGroups"
],
"summary": "Get Security Group",
"description": "Gets a single Security Group using the Security Group Id\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "SecurityGroupsByIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Security Group Id",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupQuery.Result"
}
}
}
}
}
},
"put": {
"tags": [
"SecurityGroups"
],
"summary": "Update security group",
"description": "Updates an existing security group.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): securitygroup-write ````",
"operationId": "SecurityGroupsByIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the security group",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The request body containing the security group to update.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.UpdateSecurityGroupRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.UpdateSecurityGroupRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.UpdateSecurityGroupRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.UpdateSecurityGroupRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.UpdateSecurityGroupRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.UpdateSecurityGroupRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.UpdateSecurityGroupRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.UpdateSecurityGroupRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
},
"delete": {
"tags": [
"SecurityGroups"
],
"summary": "Delete Security Group",
"description": "Deletes a Security Group and the permissions linked to it. This action is not allowed if there are users attached to the Security Group.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): securitygroup-write ````",
"operationId": "SecurityGroupsByIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Security Group Id",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/SecurityGroups/{id}/CustomData/propertyPermissions": {
"get": {
"tags": [
"SecurityGroups"
],
"summary": "Get Custom Data Property Permissions",
"description": "Returns the list of permissions set for the Custom Data Property Definitions ordered by the Property Name.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "SecurityGroupsByIdCustomDataPropertyPermissionsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the Security Group.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomData.PropertyPermissionsQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomData.PropertyPermissionsQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomData.PropertyPermissionsQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomData.PropertyPermissionsQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomData.PropertyPermissionsQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomData.PropertyPermissionsQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomData.PropertyPermissionsQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"SecurityGroups"
],
"summary": "Create Custom Data Property Permission",
"description": "Creates a permission on a custom data property definition.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): securitygroup-write ````",
"operationId": "SecurityGroupsByIdCustomDataPropertyPermissionsPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the Security Group.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The request body containing the property definition permission.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupPropertyPermissionRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupPropertyPermissionRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupPropertyPermissionRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupPropertyPermissionRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupPropertyPermissionRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupPropertyPermissionRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupPropertyPermissionRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupPropertyPermissionRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.CustomData.CreatePropertyPermissionCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.CustomData.CreatePropertyPermissionCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.CustomData.CreatePropertyPermissionCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.CustomData.CreatePropertyPermissionCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.CustomData.CreatePropertyPermissionCommand.Result"
}
}
}
}
}
}
},
"/SecurityGroups/{id}/CustomData/propertyPermissions/{propertyPermissionId}": {
"get": {
"tags": [
"SecurityGroups"
],
"summary": "Get Custom Data Property Permission by propertyPermissionId",
"description": "Returns a Custom Data Property Permission.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "SecurityGroupsByIdCustomDataPropertyPermissionsByPropertyPermissionIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the Security Group.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "propertyPermissionId",
"in": "path",
"description": "Property permission Id.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.CustomData.PropertyPermissionsQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.CustomData.PropertyPermissionsQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.CustomData.PropertyPermissionsQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.CustomData.PropertyPermissionsQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.CustomData.PropertyPermissionsQuery.Result"
}
}
}
}
}
},
"put": {
"tags": [
"SecurityGroups"
],
"summary": "Update Custom Data Property Permission",
"description": "Update a permission on a custom data property definition.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): securitygroup-write ````",
"operationId": "SecurityGroupsByIdCustomDataPropertyPermissionsByPropertyPermissionIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the Security Group.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "propertyPermissionId",
"in": "path",
"description": "The Id of the property permission.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The request body containing the property definition permission.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.UpdateSecurityGroupPropertyPermissionRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.UpdateSecurityGroupPropertyPermissionRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.UpdateSecurityGroupPropertyPermissionRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.UpdateSecurityGroupPropertyPermissionRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.UpdateSecurityGroupPropertyPermissionRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.UpdateSecurityGroupPropertyPermissionRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.UpdateSecurityGroupPropertyPermissionRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.UpdateSecurityGroupPropertyPermissionRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
},
"delete": {
"tags": [
"SecurityGroups"
],
"summary": "Delete Custom Data Property Permission",
"description": "Deletes a property definition permission setting from the Security Group.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): securitygroup-write ````",
"operationId": "SecurityGroupsByIdCustomDataPropertyPermissionsByPropertyPermissionIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the Security Group",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "propertyPermissionId",
"in": "path",
"description": "The Id of the property permission.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/SecurityGroups/{id}/kpiReports": {
"get": {
"tags": [
"SecurityGroups"
],
"summary": "Get Security Group KPI Reports List",
"description": "Returns the list of KPI reports that have been explicitly granted to the security group.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "SecurityGroupsByIdKpiReportsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the Security Group",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupKpiReport.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupKpiReport.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupKpiReport.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupKpiReport.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupKpiReport.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupKpiReport.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupKpiReport.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"SecurityGroups"
],
"summary": "Create Security Group KPI Report",
"description": "Grants a report to a Security Group.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): securitygroup-write ````",
"operationId": "SecurityGroupsByIdKpiReportsPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the Security Group",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The request body containing the report to add.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupKpiReportRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupKpiReportRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupKpiReportRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupKpiReportRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupKpiReportRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupKpiReportRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupKpiReportRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupKpiReportRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created"
}
}
}
},
"/SecurityGroups/{id}/kpiReports/{reportId}": {
"delete": {
"tags": [
"SecurityGroups"
],
"summary": "Delete Security Group KPI Report",
"description": "Revokes a report from a Security Group.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): securitygroup-write ````",
"operationId": "SecurityGroupsByIdKpiReportsByReportIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the Security Group",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "reportId",
"in": "path",
"description": "The Id of the report to revoke",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/SecurityGroups/{id}/permissions": {
"get": {
"tags": [
"SecurityGroups"
],
"summary": "Get Security Group Permissions List",
"description": "Returns the list of permissions that are granted to the Security Group.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "SecurityGroupsByIdPermissionsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the Security Group",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupPermissionsListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupPermissionsListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupPermissionsListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupPermissionsListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupPermissionsListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupPermissionsListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupPermissionsListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"SecurityGroups"
],
"summary": "Create Security Group Permission",
"description": "Grants a permission to a Security Group. The user must have the appropriate rights to grant permissions that require system administrator access.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): securitygroup-write ````",
"operationId": "SecurityGroupsByIdPermissionsPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the Security Group",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The permissionId to grant",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.PermissionRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.PermissionRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.PermissionRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.PermissionRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.PermissionRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.PermissionRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.PermissionRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.PermissionRequest"
}
}
}
},
"responses": {
"201": {
"description": "Permission created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.SecurityGroups.CreateSecurityGroupPermissionCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.SecurityGroups.CreateSecurityGroupPermissionCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.SecurityGroups.CreateSecurityGroupPermissionCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.SecurityGroups.CreateSecurityGroupPermissionCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.SecurityGroups.CreateSecurityGroupPermissionCommand.Result"
}
}
}
}
}
}
},
"/SecurityGroups/{id}/permissions/{permissionId}": {
"get": {
"tags": [
"SecurityGroups"
],
"summary": "Get Security Group Permission",
"description": "Returns the permission for the defined Security Group. A Not Found status will be returned if the permission is not granted to the Security Group.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "SecurityGroupsByIdPermissionsByPermissionIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the Security Group",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "permissionId",
"in": "path",
"description": "The Id of the permission",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupPermissionQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupPermissionQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupPermissionQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupPermissionQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupPermissionQuery.Result"
}
}
}
}
}
},
"delete": {
"tags": [
"SecurityGroups"
],
"summary": "Delete Security Group Permission",
"description": "Revokes a permission from a Security Group. The user must have the appropriate rights to revoke permissions that require system administrator access.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): securitygroup-write ````",
"operationId": "SecurityGroupsByIdPermissionsByPermissionIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the Security Group",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "permissionId",
"in": "path",
"description": "The Id of the permission to revoke",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/SecurityGroups/{id}/reportGroups": {
"get": {
"tags": [
"SecurityGroups"
],
"summary": "Get Security Group Report Groups List",
"description": "Returns the list of report groups that are granted to the Security Group.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "SecurityGroupsByIdReportGroupsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the Security Group",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupReportGroupQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupReportGroupQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupReportGroupQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupReportGroupQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupReportGroupQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupReportGroupQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupReportGroupQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"SecurityGroups"
],
"summary": "Create Security Group Report Group",
"description": "Grants a report group to a Security Group.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): securitygroup-write ````",
"operationId": "SecurityGroupsByIdReportGroupsPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the Security Group",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The request body containing the report group to add.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupReportGroupRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupReportGroupRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupReportGroupRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupReportGroupRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupReportGroupRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupReportGroupRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupReportGroupRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupReportGroupRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created"
}
}
}
},
"/SecurityGroups/{id}/reportGroups/{reportGroupId}": {
"delete": {
"tags": [
"SecurityGroups"
],
"summary": "Delete Security Group Report Group",
"description": "Revokes a report group from a Security Group.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): securitygroup-write ````",
"operationId": "SecurityGroupsByIdReportGroupsByReportGroupIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the Security Group",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "reportGroupId",
"in": "path",
"description": "The Id of the report group to revoke",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/SecurityGroups/{id}/reports": {
"get": {
"tags": [
"SecurityGroups"
],
"summary": "Get Security Group Reports List",
"description": "Returns the list of reports that have been explicitly granted to the security group. \r\nThis endpoint will only include reports that have been singled out. It will \r\nnot additionally include reports in groups that a user has also been granted access to.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "SecurityGroupsByIdReportsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the Security Group",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupReportQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupReportQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupReportQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupReportQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupReportQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupReportQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupReportQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"SecurityGroups"
],
"summary": "Create Security Group Report",
"description": "Grants a report to a Security Group.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): securitygroup-write ````",
"operationId": "SecurityGroupsByIdReportsPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the Security Group",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The request body containing the report to add.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupReportRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupReportRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupReportRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupReportRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupReportRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupReportRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupReportRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupReportRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created"
}
}
}
},
"/SecurityGroups/{id}/reports/{reportId}": {
"delete": {
"tags": [
"SecurityGroups"
],
"summary": "Delete Security Group Report",
"description": "Revokes a report from a Security Group.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): securitygroup-write ````",
"operationId": "SecurityGroupsByIdReportsByReportIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the Security Group",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "reportId",
"in": "path",
"description": "The Id of the report to revoke",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/SecurityGroups/{id}/roles": {
"get": {
"tags": [
"SecurityGroups"
],
"summary": "Get list of roles the Security Group is linked to",
"description": "Returns the list of roles linked to the Security Group.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "SecurityGroupsByIdRolesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the Security Group",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupRolesListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupRolesListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupRolesListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupRolesListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupRolesListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupRolesListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupRolesListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/SecurityGroups/{id}/users": {
"get": {
"tags": [
"SecurityGroups"
],
"summary": "Get Security Group Users List",
"description": "Returns the list of users (service reps) that are members of the Security Group.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "SecurityGroupsByIdUsersGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the Security Group",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "includeTWEmployees",
"in": "query",
"description": "When true, include reps who are also TW employees, existing in TWEmployee table.",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupUsersListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupUsersListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupUsersListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupUsersListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupUsersListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupUsersListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupUsersListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/SecurityGroups/{securityGroupId}/BeyondAdvancedPermissions": {
"get": {
"tags": [
"SecurityGroups"
],
"summary": "Get Beyond Advanced Permissions",
"description": "Returns the list of Beyond advanced permissions for the security group\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "SecurityGroupsBySecurityGroupIdBeyondAdvancedPermissionsGet",
"parameters": [
{
"name": "securityGroupId",
"in": "path",
"description": "The securityGroupId of the Security Group.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.SecurityGroups.GetSecurityGroupBeyondAdvancedPermissions.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.SecurityGroups.GetSecurityGroupBeyondAdvancedPermissions.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.SecurityGroups.GetSecurityGroupBeyondAdvancedPermissions.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.SecurityGroups.GetSecurityGroupBeyondAdvancedPermissions.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.SecurityGroups.GetSecurityGroupBeyondAdvancedPermissions.Result"
}
}
}
}
}
},
"put": {
"tags": [
"SecurityGroups"
],
"summary": "Updated Beyond Advanced Permissions",
"description": "Updates the advanced permissions for the security group\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "SecurityGroupsBySecurityGroupIdBeyondAdvancedPermissionsPut",
"parameters": [
{
"name": "securityGroupId",
"in": "path",
"description": "The securityGroupId of the Security Group.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "Lists of advanced permissions data to update",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.UpdateSecurityGroupBeyondAdvancedPermissionRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.UpdateSecurityGroupBeyondAdvancedPermissionRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.UpdateSecurityGroupBeyondAdvancedPermissionRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.UpdateSecurityGroupBeyondAdvancedPermissionRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.UpdateSecurityGroupBeyondAdvancedPermissionRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.UpdateSecurityGroupBeyondAdvancedPermissionRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.UpdateSecurityGroupBeyondAdvancedPermissionRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.UpdateSecurityGroupBeyondAdvancedPermissionRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/SecurityGroups/{securityGroupId}/customerstatuses": {
"get": {
"tags": [
"SecurityGroups"
],
"summary": "Get Security Group Customer Statuses List",
"description": "Returns the list of customer statuses that are granted to the Security Group.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "SecurityGroupsBySecurityGroupIdCustomerstatusesGet",
"parameters": [
{
"name": "securityGroupId",
"in": "path",
"description": "The Id of the Security Group",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupCustomerStatusListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupCustomerStatusListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupCustomerStatusListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupCustomerStatusListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupCustomerStatusListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupCustomerStatusListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupCustomerStatusListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"SecurityGroups"
],
"summary": "Create Security Group Customer Status",
"description": "Grants a customer status to a Security Group allowing users with the security group to change the status of a customer from the specified status. \r\nThe user must have the appropriate rights to grant customer statuses that require system administrator access.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): securitygroup-write ````",
"operationId": "SecurityGroupsBySecurityGroupIdCustomerstatusesPost",
"parameters": [
{
"name": "securityGroupId",
"in": "path",
"description": "The Id of the Security Group",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The customerStatusId to grant",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupCustomerStatusIdRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupCustomerStatusIdRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupCustomerStatusIdRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupCustomerStatusIdRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupCustomerStatusIdRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupCustomerStatusIdRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupCustomerStatusIdRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupCustomerStatusIdRequest"
}
}
}
},
"responses": {
"201": {
"description": "Customer Status created"
}
}
}
},
"/SecurityGroups/{securityGroupId}/customerstatuses/{customerStatusId}": {
"delete": {
"tags": [
"SecurityGroups"
],
"summary": "Delete Security Group Customer Status",
"description": "Revokes a customer status from a Security Group preventing users with the security group from changing the status of a customer with the specified status.\r\nThe user must have the appropriate rights to revoke customer statuses that require system administrator access.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): securitygroup-write ````",
"operationId": "SecurityGroupsBySecurityGroupIdCustomerstatusesByCustomerStatusIdDelete",
"parameters": [
{
"name": "securityGroupId",
"in": "path",
"description": "The Id of the Security Group",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "customerStatusId",
"in": "path",
"description": "The Id of the customer status to revoke",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/SecurityGroups/{securityGroupId}/dataExports": {
"get": {
"tags": [
"SecurityGroups"
],
"summary": "Get Security Group Data Exports List",
"description": "Returns the list of data exports that are granted to the Security Group.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "SecurityGroupsBySecurityGroupIdDataExportsGet",
"parameters": [
{
"name": "securityGroupId",
"in": "path",
"description": "The Id of the Security Group",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupDataExportListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupDataExportListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupDataExportListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupDataExportListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupDataExportListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupDataExportListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupDataExportListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"SecurityGroups"
],
"summary": "Create Security Group Data Export",
"description": "Grants Users with the Security Group permission to run the specified Data Export.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): securitygroup-write ````",
"operationId": "SecurityGroupsBySecurityGroupIdDataExportsPost",
"parameters": [
{
"name": "securityGroupId",
"in": "path",
"description": "The Id of the Security Group",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The exportId to grant",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupDataExportIdRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupDataExportIdRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupDataExportIdRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupDataExportIdRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupDataExportIdRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupDataExportIdRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupDataExportIdRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupDataExportIdRequest"
}
}
}
},
"responses": {
"201": {
"description": "Data Export Granted"
}
}
}
},
"/SecurityGroups/{securityGroupId}/dataExports/{exportId}": {
"delete": {
"tags": [
"SecurityGroups"
],
"summary": "Delete Security Group Data Export",
"description": "Removes permission for Users with the Security Group to run the specified Data Export.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): securitygroup-write ````",
"operationId": "SecurityGroupsBySecurityGroupIdDataExportsByExportIdDelete",
"parameters": [
{
"name": "securityGroupId",
"in": "path",
"description": "The Id of the Security Group",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "exportId",
"in": "path",
"description": "The Id of the data export to revoke",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/SecurityGroups/{securityGroupId}/dataExports/available": {
"get": {
"tags": [
"SecurityGroups"
],
"summary": "Get Security Group Available Data Exports List",
"description": "Returns a list of data exports that can be granted to the Security Group. This list will exclude those that are not visible or are already granted to the group.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): securitygroup-write ````",
"operationId": "SecurityGroupsBySecurityGroupIdDataExportsAvailableGet",
"parameters": [
{
"name": "securityGroupId",
"in": "path",
"description": "The Id of the Security Group",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupDataExportAvailableListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupDataExportAvailableListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupDataExportAvailableListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupDataExportAvailableListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupDataExportAvailableListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupDataExportAvailableListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupDataExportAvailableListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/SecurityGroups/{securityGroupId}/documentTypes": {
"get": {
"tags": [
"SecurityGroups"
],
"summary": "Get Security Group Document Types List",
"description": "Returns the list of documents that are granted to the Security Group.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "SecurityGroupsBySecurityGroupIdDocumentTypesGet",
"parameters": [
{
"name": "securityGroupId",
"in": "path",
"description": "The Id of the Security Group",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupDocumentTypeListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupDocumentTypeListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupDocumentTypeListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupDocumentTypeListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupDocumentTypeListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupDocumentTypeListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupDocumentTypeListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"SecurityGroups"
],
"summary": "Create Security Group Document Type",
"description": "Grants a document type to a Security Group allowing users with the security group to, depending on configuration, \r\nread, write, and/or delete documents of the specified type.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): securitygroup-write ````",
"operationId": "SecurityGroupsBySecurityGroupIdDocumentTypesPost",
"parameters": [
{
"name": "securityGroupId",
"in": "path",
"description": "The Id of the Security Group",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The request body specifying the document type as well as the permissions.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateDocumentTypeLinkRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateDocumentTypeLinkRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateDocumentTypeLinkRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateDocumentTypeLinkRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateDocumentTypeLinkRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateDocumentTypeLinkRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateDocumentTypeLinkRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateDocumentTypeLinkRequest"
}
}
}
},
"responses": {
"201": {
"description": "Document Type created"
}
}
}
},
"/SecurityGroups/{securityGroupId}/documentTypes/{documentTypeId}": {
"get": {
"tags": [
"SecurityGroups"
],
"summary": "Get Security Group Document Type",
"description": "Returns the document type and the permissions attributed to it.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "SecurityGroupsBySecurityGroupIdDocumentTypesByDocumentTypeIdGet",
"parameters": [
{
"name": "securityGroupId",
"in": "path",
"description": "The Id of the Security Group",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "documentTypeId",
"in": "path",
"description": "The Id of the Document Type",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupDocumentTypeListQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupDocumentTypeListQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupDocumentTypeListQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupDocumentTypeListQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupDocumentTypeListQuery.Result"
}
}
}
}
}
},
"put": {
"tags": [
"SecurityGroups"
],
"summary": "Update Security Group Document Type",
"description": "Allows for updating whether or not users with the security group can read, write, and/or delete documents of the specified type.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): securitygroup-write ````",
"operationId": "SecurityGroupsBySecurityGroupIdDocumentTypesByDocumentTypeIdPut",
"parameters": [
{
"name": "securityGroupId",
"in": "path",
"description": "The Id of the Security Group",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "documentTypeId",
"in": "path",
"description": "The Id of the Document Type",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The request body specifying the updated permissions.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.UpdateDocumentTypeLinkRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.UpdateDocumentTypeLinkRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.UpdateDocumentTypeLinkRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.UpdateDocumentTypeLinkRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.UpdateDocumentTypeLinkRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.UpdateDocumentTypeLinkRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.UpdateDocumentTypeLinkRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.UpdateDocumentTypeLinkRequest"
}
}
}
},
"responses": {
"204": {
"description": "Document Type Modified"
}
}
},
"delete": {
"tags": [
"SecurityGroups"
],
"summary": "Delete Security Group Document Type",
"description": "Revokes a document type from a Security Group preventing users with the security group from viewing, editing, and deleting \r\ndocument with that type.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): securitygroup-write ````",
"operationId": "SecurityGroupsBySecurityGroupIdDocumentTypesByDocumentTypeIdDelete",
"parameters": [
{
"name": "securityGroupId",
"in": "path",
"description": "The Id of the Security Group",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "documentTypeId",
"in": "path",
"description": "The Id of the Document Type",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/SecurityGroups/{securityGroupId}/messageActionTypes": {
"get": {
"tags": [
"SecurityGroups"
],
"summary": "Get Security Group Message Action Types List",
"description": "Returns the list of message action types that are granted to the Security Group.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "SecurityGroupsBySecurityGroupIdMessageActionTypesGet",
"parameters": [
{
"name": "securityGroupId",
"in": "path",
"description": "The Id of the Security Group",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupMessageActionTypeListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupMessageActionTypeListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupMessageActionTypeListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupMessageActionTypeListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupMessageActionTypeListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupMessageActionTypeListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupMessageActionTypeListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"SecurityGroups"
],
"summary": "Create Security Group Message Action Type",
"description": "Grants a message action type to a Security Group allowing users with the security group to, depending on configuration, \r\nread, write, and/or delete message actions of the specified type.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): securitygroup-write ````",
"operationId": "SecurityGroupsBySecurityGroupIdMessageActionTypesPost",
"parameters": [
{
"name": "securityGroupId",
"in": "path",
"description": "The Id of the Security Group",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The request body specifying the message action type as well as the permissions.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateMessageActionTypeLinkRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateMessageActionTypeLinkRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateMessageActionTypeLinkRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateMessageActionTypeLinkRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateMessageActionTypeLinkRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateMessageActionTypeLinkRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateMessageActionTypeLinkRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateMessageActionTypeLinkRequest"
}
}
}
},
"responses": {
"201": {
"description": "Message Action Type created"
}
}
}
},
"/SecurityGroups/{securityGroupId}/messageActionTypes/{messageActionTypeId}": {
"get": {
"tags": [
"SecurityGroups"
],
"summary": "Get Security Group Message Action Type",
"description": "Returns the message action type and the permissions attributed to it.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "SecurityGroupsBySecurityGroupIdMessageActionTypesByMessageActionTypeIdGet",
"parameters": [
{
"name": "securityGroupId",
"in": "path",
"description": "The Id of the Security Group",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "messageActionTypeId",
"in": "path",
"description": "The Id of the Message Action Type",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupMessageActionTypeListQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupMessageActionTypeListQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupMessageActionTypeListQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupMessageActionTypeListQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupMessageActionTypeListQuery.Result"
}
}
}
}
}
},
"put": {
"tags": [
"SecurityGroups"
],
"summary": "Update Security Group Message Action Type",
"description": "Allows for updating whether or not users with the security group can read, write, and/or delete message actions of the specified type.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): securitygroup-write ````",
"operationId": "SecurityGroupsBySecurityGroupIdMessageActionTypesByMessageActionTypeIdPut",
"parameters": [
{
"name": "securityGroupId",
"in": "path",
"description": "The Id of the Security Group",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "messageActionTypeId",
"in": "path",
"description": "The Id of the Message Action Type",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The request body specifying the updated permissions.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.UpdateMessageActionTypeLinkRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.UpdateMessageActionTypeLinkRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.UpdateMessageActionTypeLinkRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.UpdateMessageActionTypeLinkRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.UpdateMessageActionTypeLinkRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.UpdateMessageActionTypeLinkRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.UpdateMessageActionTypeLinkRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.UpdateMessageActionTypeLinkRequest"
}
}
}
},
"responses": {
"204": {
"description": "Message Action Type Modified"
}
}
},
"delete": {
"tags": [
"SecurityGroups"
],
"summary": "Delete Security Group Message Action Type",
"description": "Revokes a message action type from a Security Group preventing users with the security group from viewing, editing, and deleting \r\nmessage actions with that type.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): securitygroup-write ````",
"operationId": "SecurityGroupsBySecurityGroupIdMessageActionTypesByMessageActionTypeIdDelete",
"parameters": [
{
"name": "securityGroupId",
"in": "path",
"description": "The Id of the Security Group",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "messageActionTypeId",
"in": "path",
"description": "The Id of the Message Action Type",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/SecurityGroups/kpiReports/available": {
"get": {
"tags": [
"SecurityGroups"
],
"summary": "Get Kpi Reports filter by service rep hierarchy and hierarchy selected for security group.",
"description": "Returns a list of Key Performance Indicator or KPI Reports visible to the current user based off of their Role and selected security group hierarchy.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "SecurityGroupsKpiReportsAvailableGet",
"parameters": [
{
"name": "hierId",
"in": "query",
"description": "Additional hier id to filter on. Could be security group's hier id.",
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.AvailableKpiReportList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.AvailableKpiReportList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.AvailableKpiReportList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.AvailableKpiReportList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.AvailableKpiReportList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.AvailableKpiReportList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.AvailableKpiReportList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Staging/Employees": {
"get": {
"tags": [
"Staging"
],
"summary": "Get Staged Employees with statuses",
"description": "Returns a list of Staged Employees.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "StagingEmployeesGet",
"parameters": [
{
"name": "filterByServiceRepId",
"in": "query",
"description": "Filter staged employees by the service rep who imported them.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "filterType",
"in": "query",
"description": "Filters the staged employees by the type specified. Allowed types include null, All, Ready, Proofed, Duplicate, and Error.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of rows to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of rows to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeWithStatus, Staging.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeWithStatus, Staging.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeWithStatus, Staging.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeWithStatus, Staging.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeWithStatus, Staging.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeWithStatus, Staging.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeWithStatus, Staging.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Staging/Employees/{stagedEmployeeId}": {
"get": {
"tags": [
"Staging"
],
"summary": "Get Staged Employee",
"description": "Gets the staged employee.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "StagingEmployeesByStagedEmployeeIdGet",
"parameters": [
{
"name": "stagedEmployeeId",
"in": "path",
"description": "The Id of the staged employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Models.StagedEmployee"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Models.StagedEmployee"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Models.StagedEmployee"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Models.StagedEmployee"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Models.StagedEmployee"
}
}
}
}
}
},
"put": {
"tags": [
"Staging"
],
"summary": "Update Staged Employee",
"description": "Updates the staged employee.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "StagingEmployeesByStagedEmployeeIdPut",
"parameters": [
{
"name": "stagedEmployeeId",
"in": "path",
"description": "The Id of the staged employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The staged employee details.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Staging/Employees/{stagedEmployeeId}/ContactMethods": {
"get": {
"tags": [
"Staging"
],
"summary": "Get Staged Employee Contact Methods",
"description": "Returns a list of Staged Employee Contact Methods.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "StagingEmployeesByStagedEmployeeIdContactMethodsGet",
"parameters": [
{
"name": "stagedEmployeeId",
"in": "path",
"description": "The unique Id of the Staged Employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of rows to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of rows to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeContactMethod, Staging.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeContactMethod, Staging.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeContactMethod, Staging.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeContactMethod, Staging.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeContactMethod, Staging.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeContactMethod, Staging.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeContactMethod, Staging.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Staging"
],
"summary": "Create Staged Employee Contact Method",
"description": "Creates the staged employee contact method.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "StagingEmployeesByStagedEmployeeIdContactMethodsPost",
"parameters": [
{
"name": "stagedEmployeeId",
"in": "path",
"description": "The Id of the staged employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The staged employee contact method details.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeContactMethodRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeContactMethodRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeContactMethodRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeContactMethodRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeContactMethodRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeContactMethodRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeContactMethodRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeContactMethodRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Commands.CreateStagedEmployeeContactMethod.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Commands.CreateStagedEmployeeContactMethod.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Commands.CreateStagedEmployeeContactMethod.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Commands.CreateStagedEmployeeContactMethod.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Commands.CreateStagedEmployeeContactMethod.Result"
}
}
}
}
}
}
},
"/Staging/Employees/{stagedEmployeeId}/ContactMethods/{stagedEmployeeContactMethodId}": {
"get": {
"tags": [
"Staging"
],
"summary": "Get Staged Employee Contact Method",
"description": "Gets the staged employee contact method.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "StagingEmployeesByStagedEmployeeIdContactMethodsByStagedEmployeeContactMethodIdGet",
"parameters": [
{
"name": "stagedEmployeeId",
"in": "path",
"description": "The Id of the staged employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "stagedEmployeeContactMethodId",
"in": "path",
"description": "The Id of the staged employee contact method.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeContactMethod"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeContactMethod"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeContactMethod"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeContactMethod"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeContactMethod"
}
}
}
}
}
},
"put": {
"tags": [
"Staging"
],
"summary": "Update Staged Employee Contact Method",
"description": "Updates the staged employee contact method.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "StagingEmployeesByStagedEmployeeIdContactMethodsByStagedEmployeeContactMethodIdPut",
"parameters": [
{
"name": "stagedEmployeeId",
"in": "path",
"description": "The Id of the staged employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "stagedEmployeeContactMethodId",
"in": "path",
"description": "The Id of the staged employee contact method.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The staged employee contact method details.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeContactMethodRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeContactMethodRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeContactMethodRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeContactMethodRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeContactMethodRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeContactMethodRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeContactMethodRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeContactMethodRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
},
"delete": {
"tags": [
"Staging"
],
"summary": "Delete Staged Employee Contact Method",
"description": "Deletes the staged employee contact method.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "StagingEmployeesByStagedEmployeeIdContactMethodsByStagedEmployeeContactMethodIdDelete",
"parameters": [
{
"name": "stagedEmployeeId",
"in": "path",
"description": "The Id of the staged employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "stagedEmployeeContactMethodId",
"in": "path",
"description": "The Id of the staged employee contact method.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Staging/Employees/{stagedEmployeeId}/ConvertToEmployee": {
"post": {
"tags": [
"Staging"
],
"summary": "Create a permanent employee from a staged employee",
"description": "Before calling this endpoint, call `POST BatchJobs` with BatchJobType = 'CREATE_EMPLOYEE_FROM_STAGING' and BatchJobParameters = DefaultSettings json object, \r\nwhere DefaultSettings has the following form:\r\n int ServiceRepId\r\n int? OrderTypeId\r\n string EmployeeStatusId\r\n int? HowHeardOfId\r\n string HowHeardOfDetail\r\n Guid? EmploymentCategoryId\r\n int BranchId\r\n bool IsEmployeeActive\r\n int? WashedStatusId\r\n int? MessageActionId\r\n string LoggedMessage\r\nUse the result as parameter BatchJobId.\r\n\r\nThis endpoint returns BatchJobItemId. Call `GET BatchJobs/{BatchJobId}/Items` to see the status of the batch job items, including for BatchJobItemId.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "StagingEmployeesByStagedEmployeeIdConvertToEmployeePost",
"parameters": [
{
"name": "stagedEmployeeId",
"in": "path",
"description": "Staged Employee Id",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "Request object containing Batch Job Id",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Controllers.RequestModels.ConvertStagedEmployeeToEmployeeRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Controllers.RequestModels.ConvertStagedEmployeeToEmployeeRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Controllers.RequestModels.ConvertStagedEmployeeToEmployeeRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Controllers.RequestModels.ConvertStagedEmployeeToEmployeeRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Controllers.RequestModels.ConvertStagedEmployeeToEmployeeRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Controllers.RequestModels.ConvertStagedEmployeeToEmployeeRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Controllers.RequestModels.ConvertStagedEmployeeToEmployeeRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Controllers.RequestModels.ConvertStagedEmployeeToEmployeeRequest"
}
}
}
},
"responses": {
"202": {
"description": "Accepted"
},
"201": {
"description": "Batch Job Item Created"
}
}
}
},
"/Staging/Employees/{stagedEmployeeId}/documents/{documentId}/bytes": {
"get": {
"tags": [
"Staging"
],
"summary": "Get Staged Employee Document",
"description": "Gets the specified Document for the specified Staged Employee.\n \n```` Allows roles: ServiceRep, WebUserEmployee ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "StagingEmployeesByStagedEmployeeIdDocumentsByDocumentIdBytesGet",
"parameters": [
{
"name": "stagedEmployeeId",
"in": "path",
"description": "The Id of the staged employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "documentId",
"in": "path",
"description": "The Id of the document.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "returnPdf",
"in": "query",
"description": "Used to indicate whether or not a PDF should be returned if the file is convertible to PDF, if convert fails then nothing is returned",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "string",
"format": "byte"
}
},
"text/csv": {
"schema": {
"type": "string",
"format": "byte"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"type": "string",
"format": "byte"
}
},
"application/json": {
"schema": {
"type": "string",
"format": "byte"
}
},
"text/json": {
"schema": {
"type": "string",
"format": "byte"
}
},
"application/xml": {
"schema": {
"type": "string",
"format": "byte"
}
},
"text/xml": {
"schema": {
"type": "string",
"format": "byte"
}
}
}
}
}
}
},
"/Staging/Employees/{stagedEmployeeId}/duplicates": {
"get": {
"tags": [
"Staging"
],
"summary": "Get Staged Employee duplicates by Staged Employee Id",
"description": "Return a list of staged employee duplicates\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "StagingEmployeesByStagedEmployeeIdDuplicatesGet",
"parameters": [
{
"name": "stagedEmployeeId",
"in": "path",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Staging.Service.Employee.Commands.StagedEmployeeDuplicatesQuery.Result, Staging.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Staging.Service.Employee.Commands.StagedEmployeeDuplicatesQuery.Result, Staging.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Staging.Service.Employee.Commands.StagedEmployeeDuplicatesQuery.Result, Staging.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Staging.Service.Employee.Commands.StagedEmployeeDuplicatesQuery.Result, Staging.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Staging.Service.Employee.Commands.StagedEmployeeDuplicatesQuery.Result, Staging.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Staging.Service.Employee.Commands.StagedEmployeeDuplicatesQuery.Result, Staging.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Staging.Service.Employee.Commands.StagedEmployeeDuplicatesQuery.Result, Staging.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Staging/Employees/{stagedEmployeeId}/Education": {
"get": {
"tags": [
"Staging"
],
"summary": "Get Staged Employee Education",
"description": "Returns a list of Staged Employee Education.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "StagingEmployeesByStagedEmployeeIdEducationGet",
"parameters": [
{
"name": "stagedEmployeeId",
"in": "path",
"description": "The unique Id of the Staged Employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of rows to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of rows to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeEducation, Staging.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeEducation, Staging.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeEducation, Staging.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeEducation, Staging.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeEducation, Staging.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeEducation, Staging.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeEducation, Staging.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Staging"
],
"summary": "Create Staged Employee Education",
"description": "Creates the staged employee education.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "StagingEmployeesByStagedEmployeeIdEducationPost",
"parameters": [
{
"name": "stagedEmployeeId",
"in": "path",
"description": "The Id of the staged employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The staged employee education details.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeEducationRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeEducationRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeEducationRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeEducationRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeEducationRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeEducationRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeEducationRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeEducationRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Commands.CreateStagedEmployeeEducation.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Commands.CreateStagedEmployeeEducation.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Commands.CreateStagedEmployeeEducation.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Commands.CreateStagedEmployeeEducation.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Commands.CreateStagedEmployeeEducation.Result"
}
}
}
}
}
}
},
"/Staging/Employees/{stagedEmployeeId}/Education/{stagedEmployeeEducationId}": {
"get": {
"tags": [
"Staging"
],
"summary": "Get Staged Employee Education",
"description": "Gets the staged employee education.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "StagingEmployeesByStagedEmployeeIdEducationByStagedEmployeeEducationIdGet",
"parameters": [
{
"name": "stagedEmployeeId",
"in": "path",
"description": "The Id of the staged employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "stagedEmployeeEducationId",
"in": "path",
"description": "The Id of the staged employee education.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeEducation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeEducation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeEducation"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeEducation"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeEducation"
}
}
}
}
}
},
"put": {
"tags": [
"Staging"
],
"summary": "Update Staged Employee Education",
"description": "Updates the staged employee education.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "StagingEmployeesByStagedEmployeeIdEducationByStagedEmployeeEducationIdPut",
"parameters": [
{
"name": "stagedEmployeeId",
"in": "path",
"description": "The Id of the staged employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "stagedEmployeeEducationId",
"in": "path",
"description": "The Id of the staged employee education.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The staged employee education details.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeEducationRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeEducationRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeEducationRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeEducationRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeEducationRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeEducationRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeEducationRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeEducationRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
},
"delete": {
"tags": [
"Staging"
],
"summary": "Delete Staged Employee Education",
"description": "Deletes the staged employee education.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "StagingEmployeesByStagedEmployeeIdEducationByStagedEmployeeEducationIdDelete",
"parameters": [
{
"name": "stagedEmployeeId",
"in": "path",
"description": "The Id of the staged employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "stagedEmployeeEducationId",
"in": "path",
"description": "The Id of the staged employee education.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Staging/Employees/{stagedEmployeeId}/InterestCodes": {
"get": {
"tags": [
"Staging"
],
"summary": "Get Staged Employee Interest Codes",
"description": "Returns a list of Staged Employee Interest Codes.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "StagingEmployeesByStagedEmployeeIdInterestCodesGet",
"parameters": [
{
"name": "stagedEmployeeId",
"in": "path",
"description": "The unique Id of the Staged Employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of rows to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of rows to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeInterestCode, Staging.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeInterestCode, Staging.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeInterestCode, Staging.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeInterestCode, Staging.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeInterestCode, Staging.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeInterestCode, Staging.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeInterestCode, Staging.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Staging"
],
"summary": "Create Staged Employee Interest Code",
"description": "Creates the staged employee interest code.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "StagingEmployeesByStagedEmployeeIdInterestCodesPost",
"parameters": [
{
"name": "stagedEmployeeId",
"in": "path",
"description": "The Id of the staged employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The staged employee interest code details.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeInterestCodeRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeInterestCodeRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeInterestCodeRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeInterestCodeRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeInterestCodeRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeInterestCodeRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeInterestCodeRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeInterestCodeRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Commands.CreateStagedEmployeeInterestCode.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Commands.CreateStagedEmployeeInterestCode.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Commands.CreateStagedEmployeeInterestCode.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Commands.CreateStagedEmployeeInterestCode.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Commands.CreateStagedEmployeeInterestCode.Result"
}
}
}
}
}
}
},
"/Staging/Employees/{stagedEmployeeId}/InterestCodes/{stagedEmployeeInterestCodeId}": {
"get": {
"tags": [
"Staging"
],
"summary": "Get Staged Employee Interest Code",
"description": "Gets the staged employee interest code.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "StagingEmployeesByStagedEmployeeIdInterestCodesByStagedEmployeeInterestCodeIdGet",
"parameters": [
{
"name": "stagedEmployeeId",
"in": "path",
"description": "The Id of the staged employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "stagedEmployeeInterestCodeId",
"in": "path",
"description": "The Id of the staged employee interest code.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeInterestCode"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeInterestCode"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeInterestCode"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeInterestCode"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeInterestCode"
}
}
}
}
}
},
"put": {
"tags": [
"Staging"
],
"summary": "Update Staged Employee Interest Code",
"description": "Updates the staged employee interest code.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "StagingEmployeesByStagedEmployeeIdInterestCodesByStagedEmployeeInterestCodeIdPut",
"parameters": [
{
"name": "stagedEmployeeId",
"in": "path",
"description": "The Id of the staged employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "stagedEmployeeInterestCodeId",
"in": "path",
"description": "The Id of the staged employee interest code.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The staged employee interest code details.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeInterestCodeRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeInterestCodeRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeInterestCodeRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeInterestCodeRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeInterestCodeRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeInterestCodeRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeInterestCodeRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeInterestCodeRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
},
"delete": {
"tags": [
"Staging"
],
"summary": "Delete Staged Employee Interest Code",
"description": "Deletes the staged employee interest code.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "StagingEmployeesByStagedEmployeeIdInterestCodesByStagedEmployeeInterestCodeIdDelete",
"parameters": [
{
"name": "stagedEmployeeId",
"in": "path",
"description": "The Id of the staged employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "stagedEmployeeInterestCodeId",
"in": "path",
"description": "The Id of the staged employee interest code.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Staging/Employees/{stagedEmployeeId}/Merge": {
"post": {
"tags": [
"Staging"
],
"summary": "Adds education, interest code, work history, and contact methods from Staged Employee to Employee",
"description": "Adds staged employee's Education, Interest Codes, Work History, and Contact Methods to employee's existing data.\n \n```` Allows roles: ServiceRep, WebUserEmployee ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "StagingEmployeesByStagedEmployeeIdMergePost",
"parameters": [
{
"name": "stagedEmployeeId",
"in": "path",
"description": "Id of staged employee (source of merge).",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "Request object for merging staged employee into employee.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.MergeStagedEmployeeIntoEmployeeRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.MergeStagedEmployeeIntoEmployeeRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.MergeStagedEmployeeIntoEmployeeRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.MergeStagedEmployeeIntoEmployeeRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.MergeStagedEmployeeIntoEmployeeRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.MergeStagedEmployeeIntoEmployeeRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.MergeStagedEmployeeIntoEmployeeRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.MergeStagedEmployeeIntoEmployeeRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content",
"content": {
"text/plain": {
"schema": {
"type": "string",
"format": "byte"
}
},
"text/csv": {
"schema": {
"type": "string",
"format": "byte"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"type": "string",
"format": "byte"
}
},
"application/json": {
"schema": {
"type": "string",
"format": "byte"
}
},
"text/json": {
"schema": {
"type": "string",
"format": "byte"
}
},
"application/xml": {
"schema": {
"type": "string",
"format": "byte"
}
},
"text/xml": {
"schema": {
"type": "string",
"format": "byte"
}
}
}
}
}
}
},
"/Staging/Employees/{stagedEmployeeId}/StatusDetails": {
"get": {
"tags": [
"Staging"
],
"summary": "Get Staged Employee with status by Staged Employee Id",
"description": "Return properties and status of the staged employee\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "StagingEmployeesByStagedEmployeeIdStatusDetailsGet",
"parameters": [
{
"name": "stagedEmployeeId",
"in": "path",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeWithStatus"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeWithStatus"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeWithStatus"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeWithStatus"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeWithStatus"
}
}
}
}
}
}
},
"/Staging/Employees/{stagedEmployeeId}/WorkExperience": {
"get": {
"tags": [
"Staging"
],
"summary": "Get Staged Employee Work Experience",
"description": "Returns a list of Staged Employee Work Experience.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "StagingEmployeesByStagedEmployeeIdWorkExperienceGet",
"parameters": [
{
"name": "stagedEmployeeId",
"in": "path",
"description": "The unique Id of the Staged Employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of rows to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of rows to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeWorkExperience, Staging.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeWorkExperience, Staging.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeWorkExperience, Staging.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeWorkExperience, Staging.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeWorkExperience, Staging.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeWorkExperience, Staging.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeWorkExperience, Staging.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Staging"
],
"summary": "Create Staged Employee Work Experience",
"description": "Creates the staged employee work experience.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "StagingEmployeesByStagedEmployeeIdWorkExperiencePost",
"parameters": [
{
"name": "stagedEmployeeId",
"in": "path",
"description": "The Id of the staged employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The staged employee work experience details.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeWorkExperienceRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeWorkExperienceRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeWorkExperienceRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeWorkExperienceRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeWorkExperienceRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeWorkExperienceRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeWorkExperienceRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeWorkExperienceRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Commands.CreateStagedEmployeeWorkExperience.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Commands.CreateStagedEmployeeWorkExperience.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Commands.CreateStagedEmployeeWorkExperience.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Commands.CreateStagedEmployeeWorkExperience.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Commands.CreateStagedEmployeeWorkExperience.Result"
}
}
}
}
}
}
},
"/Staging/Employees/{stagedEmployeeId}/WorkExperience/{stagedEmployeeWorkExperienceId}": {
"get": {
"tags": [
"Staging"
],
"summary": "Get Staged Employee Work Experience",
"description": "Gets the staged employee work experience.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "StagingEmployeesByStagedEmployeeIdWorkExperienceByStagedEmployeeWorkExperienceIdGet",
"parameters": [
{
"name": "stagedEmployeeId",
"in": "path",
"description": "The Id of the staged employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "stagedEmployeeWorkExperienceId",
"in": "path",
"description": "The Id of the staged employee work experience.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeWorkExperience"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeWorkExperience"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeWorkExperience"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeWorkExperience"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeWorkExperience"
}
}
}
}
}
},
"put": {
"tags": [
"Staging"
],
"summary": "Update Staged Employee Work Experience",
"description": "Updates the staged employee work experience.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "StagingEmployeesByStagedEmployeeIdWorkExperienceByStagedEmployeeWorkExperienceIdPut",
"parameters": [
{
"name": "stagedEmployeeId",
"in": "path",
"description": "The Id of the staged employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "stagedEmployeeWorkExperienceId",
"in": "path",
"description": "The Id of the staged employee work experience.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The staged employee work experience details.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeWorkExperienceRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeWorkExperienceRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeWorkExperienceRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeWorkExperienceRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeWorkExperienceRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeWorkExperienceRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeWorkExperienceRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.UpsertStagedEmployeeWorkExperienceRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
},
"delete": {
"tags": [
"Staging"
],
"summary": "Delete Staged Employee Work Experience",
"description": "Deletes the staged employee work experience.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "StagingEmployeesByStagedEmployeeIdWorkExperienceByStagedEmployeeWorkExperienceIdDelete",
"parameters": [
{
"name": "stagedEmployeeId",
"in": "path",
"description": "The Id of the staged employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "stagedEmployeeWorkExperienceId",
"in": "path",
"description": "The Id of the staged employee work experience.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Staging/Employees/DefaultSettings": {
"get": {
"tags": [
"Staging"
],
"summary": "Get Staged Employee Default Settings",
"description": "Returns Default Settings for the Staged Employee.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "StagingEmployeesDefaultSettingsGet",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Models.ResumeDefaultSettings"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Models.ResumeDefaultSettings"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Models.ResumeDefaultSettings"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Models.ResumeDefaultSettings"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Models.ResumeDefaultSettings"
}
}
}
}
}
}
},
"/Staging/Employees/delete": {
"post": {
"tags": [
"Staging"
],
"summary": "Delete Staged Employees Data",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "StagingEmployeesDeletePost",
"requestBody": {
"description": "Request object that has a list of staged employee Ids to delete.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.DeleteStagedEmployeeRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.DeleteStagedEmployeeRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.DeleteStagedEmployeeRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.DeleteStagedEmployeeRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.DeleteStagedEmployeeRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.DeleteStagedEmployeeRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.DeleteStagedEmployeeRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.DeleteStagedEmployeeRequest"
}
}
}
},
"responses": {
"202": {
"description": "Id of the new batch job",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Commands.DeleteStagedEmployeesSetup.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Commands.DeleteStagedEmployeesSetup.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Commands.DeleteStagedEmployeesSetup.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Commands.DeleteStagedEmployeesSetup.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Commands.DeleteStagedEmployeesSetup.Result"
}
}
}
}
}
}
},
"/Staging/Employees/Resumes": {
"post": {
"tags": [
"Staging"
],
"summary": "Stage Resume",
"description": "Stages a resume to be parsed into a staged employee if the resume is not already staged.\r\n\r\nFor more information about using formdata, see: https://developer.mozilla.org/en-US/docs/Web/API/FormData/FormData\r\nFor more information about using multimart/form-data, see: http://stackoverflow.com/questions/4526273/what-does-enctype-multipart-form-data-mean\r\n\r\nBelow is an example multipart/form-data POST request form body:\r\n\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn\r\nContent-Disposition: form-data; name=\"resumeFile\"; filename=\"test-resume.txt\"\r\nContent-Type: text/plain\r\n\r\nThis is where the file content is placed! This is a valid for a text document!\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn\r\nContent-Disposition: form-data; name=\"batchJobId\"\r\n\r\n123456\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn--\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): employee-write ````",
"operationId": "StagingEmployeesResumesPost",
"responses": {
"202": {
"description": "Accepted"
}
}
}
},
"/Staging/resume/createresume": {
"post": {
"tags": [
"Staging"
],
"summary": "Create Resumes",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "StagingResumeCreateresumePost",
"requestBody": {
"description": "The parameters needed to created resumes for one or more employees",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.CreateStagedResumeRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.CreateStagedResumeRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.CreateStagedResumeRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.CreateStagedResumeRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.CreateStagedResumeRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.CreateStagedResumeRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.CreateStagedResumeRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Staging.API.Models.CreateStagedResumeRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/System/configurations/cached": {
"delete": {
"tags": [
"System"
],
"summary": "Remove cached system configurations",
"description": "Removes all cached system configurations from the api for the current user. Call this to allow a refresh of the system configurations for a user.\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): configuration-read ````",
"operationId": "SystemConfigurationsCachedDelete",
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/System/configurations/productConfigurations": {
"get": {
"tags": [
"System"
],
"summary": "Get Product Configurations",
"description": "Returns a list of Configurations for the Product Instance.\n \n```` Allows roles: ServiceRep, WebUserEmployee ````\n \n```` Requires scope(s): productinstance-read or productinstance-write ````",
"operationId": "SystemConfigurationsProductConfigurationsGet",
"parameters": [
{
"name": "productInstanceId",
"in": "query",
"description": "The Id of the Product Instance the configurations will be configured for",
"style": "form",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "configurationTypeIds",
"in": "query",
"description": "A set of specific configurations to fetch. Each should be supplied as a separate query string parameter.\r\nI.E. system/configurations/productConfigurations?configurationTypeIds=webcenter-url&configurationTypeIds=0F8BB4F9-969C-410B-B4A8-0D57EC3136DC\r\n \r\nTo get a list of possible configurationTypeIds, simply do not specify this property and inspect the results.",
"style": "form",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "relatedOriginId",
"in": "query",
"description": "Some configurations are dependent on another record aside from the authenticated web user. This is\r\nthe primary Id of the related record. Used in conjunction with relatedOriginTypeId.",
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "relatedOriginTypeId",
"in": "query",
"description": "Some configurations are dependent on another record aside from the authenticated web user. This is\r\nthe Origin Type of the related record. Currently only Customer (2) is used. Used in conjunction with relatedOriginId.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "tag",
"in": "query",
"description": "If specified, the results will be limited to only configuration types with the provided tag.",
"style": "form",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Shared.Models.Configuration.ProductConfiguration, Shared.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Shared.Models.Configuration.ProductConfiguration, Shared.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Shared.Models.Configuration.ProductConfiguration, Shared.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Shared.Models.Configuration.ProductConfiguration, Shared.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Shared.Models.Configuration.ProductConfiguration, Shared.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Shared.Models.Configuration.ProductConfiguration, Shared.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Shared.Models.Configuration.ProductConfiguration, Shared.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/System/configurations/productConfigurations/cached": {
"delete": {
"tags": [
"System"
],
"summary": "Remove cached product configurations",
"description": "Removes cached product configurations from the api for the current user. Call this to allow a refresh of the product configurations for a user.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): productinstance-read or productinstance-write ````",
"operationId": "SystemConfigurationsProductConfigurationsCachedDelete",
"parameters": [
{
"name": "configurationTypeIds",
"in": "query",
"description": "A set of specific configurations to clear out. Each should be supplied as a separate query string parameter.\r\nI.E. system/configurations/productConfigurations/cached?configurationTypeIds=webcenter-url&configurationTypeIds=0F8BB4F9-969C-410B-B4A8-0D57EC3136DC\r\n \r\nTo get a list of possible use the system/configurations/productConfigurations/ endpoint.\r\nIf not provided, all cached product configurations for the tenant will be removed from the cache.",
"style": "form",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/System/productInstances/{productInstanceId}/configurations": {
"get": {
"tags": [
"System"
],
"summary": "Get Product Instance Configurations",
"description": "Returns a list of Configurations for the Product Instance.\n \n```` Allows roles: ServiceRep, WebUserEmployee, Service ````\n \n```` Requires scope(s): productinstance-read or productinstance-write ````",
"operationId": "SystemProductInstancesByProductInstanceIdConfigurationsGet",
"parameters": [
{
"name": "productInstanceId",
"in": "path",
"description": "The Id of the Product Instance",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.ProductInstances.ProductInstanceConfigurationsQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.ProductInstances.ProductInstanceConfigurationsQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.ProductInstances.ProductInstanceConfigurationsQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.ProductInstances.ProductInstanceConfigurationsQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.ProductInstances.ProductInstanceConfigurationsQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.ProductInstances.ProductInstanceConfigurationsQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.ProductInstances.ProductInstanceConfigurationsQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/System/productInstances/{productInstanceId}/configurations/{productConfigurationTypeId}": {
"get": {
"tags": [
"System"
],
"summary": "Get Product Instance Configuration",
"description": "Returns the specified Configuration for the Product Instance.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): productinstance-read or productinstance-write ````",
"operationId": "SystemProductInstancesByProductInstanceIdConfigurationsByProductConfigurationTypeIdGet",
"parameters": [
{
"name": "productInstanceId",
"in": "path",
"description": "The Id of the Product Instance",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "productConfigurationTypeId",
"in": "path",
"description": "The Id of the Product Configuration Type",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.ProductInstances.ProductInstanceConfigurationsQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.ProductInstances.ProductInstanceConfigurationsQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.ProductInstances.ProductInstanceConfigurationsQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.ProductInstances.ProductInstanceConfigurationsQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.ProductInstances.ProductInstanceConfigurationsQuery.Result"
}
}
}
}
}
}
},
"/Tasks": {
"get": {
"tags": [
"Tasks"
],
"summary": "Get Task List",
"description": "Returns the list of tasks belonging to the current user.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): task-read or task-write ````",
"operationId": "TasksGet",
"parameters": [
{
"name": "TaskQueryType",
"in": "query",
"required": true,
"style": "form",
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Enums.TaskQueryTypes"
}
},
{
"name": "Skip",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Take",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "StartDueDate",
"in": "query",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "EndDueDate",
"in": "query",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "Priority",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "IncludeNullDueDates",
"in": "query",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "FilterText",
"in": "query",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "AssignedToServiceRepId",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "TeamId",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "CreatedByServiceRepId",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "IsPinned",
"in": "query",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "StartDateArchived",
"in": "query",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "EndDateArchived",
"in": "query",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "OrderBy",
"in": "query",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "OrderByAscending",
"in": "query",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "Tags",
"in": "query",
"style": "form",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Tasks.TaskListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Tasks.TaskListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Tasks.TaskListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Tasks.TaskListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Tasks.TaskListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Tasks.TaskListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Tasks.TaskListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Tasks"
],
"summary": "Create Task",
"description": "Creates a task for the authenticated user.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): task-write ````",
"operationId": "TasksPost",
"requestBody": {
"description": "The request body containing the information about the new task.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateTaskRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateTaskRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateTaskRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateTaskRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateTaskRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateTaskRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateTaskRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.CreateTaskRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.CreateTaskCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.CreateTaskCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.CreateTaskCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.CreateTaskCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.CreateTaskCommand.Result"
}
}
}
}
}
}
},
"/Tasks/{taskId}": {
"get": {
"tags": [
"Tasks"
],
"summary": "Get Task Details",
"description": "Returns detailed information about the task.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): task-read or task-write ````",
"operationId": "TasksByTaskIdGet",
"parameters": [
{
"name": "taskId",
"in": "path",
"description": "The Id of the task.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.TaskDetailsQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.TaskDetailsQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.TaskDetailsQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.TaskDetailsQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.TaskDetailsQuery.Result"
}
}
}
}
}
},
"put": {
"tags": [
"Tasks"
],
"summary": "Update Task",
"description": "Updates the task.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): task-write ````",
"operationId": "TasksByTaskIdPut",
"parameters": [
{
"name": "taskId",
"in": "path",
"description": "The Id of the task.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The body of the request containing the updated task details.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.UpdateTaskRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.UpdateTaskRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.UpdateTaskRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.UpdateTaskRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.UpdateTaskRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.UpdateTaskRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.UpdateTaskRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.UpdateTaskRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Tasks/{taskId}/archive": {
"put": {
"tags": [
"Tasks"
],
"summary": "Archive Task",
"description": "Archives the task.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): task-write ````",
"operationId": "TasksByTaskIdArchivePut",
"parameters": [
{
"name": "taskId",
"in": "path",
"description": "The Id of the task.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Tasks/{taskId}/assign": {
"put": {
"tags": [
"Tasks"
],
"summary": "Assign Task",
"description": "Assigns the task.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): task-write ````",
"operationId": "TasksByTaskIdAssignPut",
"parameters": [
{
"name": "taskId",
"in": "path",
"description": "The Id of the task.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The body of the request containing the new assignment details for the task.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Tasks.AssignTaskRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Tasks/{taskId}/messages": {
"get": {
"tags": [
"Tasks"
],
"summary": "Get Task Messages List",
"description": "Returns the list of messages linked to the task.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): task-read or task-write ````",
"operationId": "TasksByTaskIdMessagesGet",
"parameters": [
{
"name": "taskId",
"in": "path",
"description": "The Id of the task.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Tasks"
],
"summary": "Create Task Message",
"description": "Creates a message and links it to the Task as well as any related Entities.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): task-read or task-write ````",
"operationId": "TasksByTaskIdMessagesPost",
"parameters": [
{
"name": "taskId",
"in": "path",
"description": "The Id of the task.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The body of the message containing the new message details.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.CreateContactMessageResult"
}
}
}
}
}
}
},
"/Tasks/{taskId}/messages/{messageId}": {
"get": {
"tags": [
"Tasks"
],
"summary": "Get Task Message Details",
"description": "Returns details about the message.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): task-read or task-write ````",
"operationId": "TasksByTaskIdMessagesByMessageIdGet",
"parameters": [
{
"name": "taskId",
"in": "path",
"description": "The Id of the task.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "messageId",
"in": "path",
"description": "The Id of the message.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageSummary"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageSummary"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageSummary"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageSummary"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageSummary"
}
}
}
}
}
}
},
"/Tasks/{taskId}/pin": {
"put": {
"tags": [
"Tasks"
],
"summary": "Pin Task",
"description": "Pin the task.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): task-write ````",
"operationId": "TasksByTaskIdPinPut",
"parameters": [
{
"name": "taskId",
"in": "path",
"description": "The Id of the task.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Tasks/{taskId}/unarchive": {
"put": {
"tags": [
"Tasks"
],
"summary": "Unarchive Task",
"description": "Unarchives the task.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): task-write ````",
"operationId": "TasksByTaskIdUnarchivePut",
"parameters": [
{
"name": "taskId",
"in": "path",
"description": "The Id of the task.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Tasks/{taskId}/unpin": {
"put": {
"tags": [
"Tasks"
],
"summary": "Unpin Task",
"description": "Pin the task.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): task-write ````",
"operationId": "TasksByTaskIdUnpinPut",
"parameters": [
{
"name": "taskId",
"in": "path",
"description": "The Id of the task.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Tasks/tags": {
"get": {
"tags": [
"Tasks"
],
"summary": "Get Task Tags",
"description": "Returns the list of tags already in use by the system.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): task-read or task-write ````",
"operationId": "TasksTagsGet",
"parameters": [
{
"name": "filter",
"in": "query",
"description": "An optional parameter that will limit results to tags starting with the specified value.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Tasks.Service.Commands.ExistingTagListQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Tasks.Service.Commands.ExistingTagListQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Tasks.Service.Commands.ExistingTagListQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Tasks.Service.Commands.ExistingTagListQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Tasks.Service.Commands.ExistingTagListQuery.Result"
}
}
}
}
}
}
},
"/Teams/{id}/savedSearches": {
"get": {
"tags": [
"Teams"
],
"summary": "Get Team Searches List",
"description": "Returns the list of saved searches that have been shared with a team of service reps. \r\nThis endpoint will only include saved searches that have been singled out. It will \r\nnot additionally include saved searches in teams that a user has also been granted access to.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "TeamsByIdSavedSearchesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the Team",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.ServiceRepTeams.ServiceRepTeamSavedSearchesQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.ServiceRepTeams.ServiceRepTeamSavedSearchesQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.ServiceRepTeams.ServiceRepTeamSavedSearchesQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.ServiceRepTeams.ServiceRepTeamSavedSearchesQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.ServiceRepTeams.ServiceRepTeamSavedSearchesQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.ServiceRepTeams.ServiceRepTeamSavedSearchesQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.ServiceRepTeams.ServiceRepTeamSavedSearchesQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Teams"
],
"summary": "Add Team Saved Search",
"description": "Grants a saved search to a Team.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "TeamsByIdSavedSearchesPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the Team",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The request body containing the saved search to add.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.ServiceRepTeams.RequestModels.AddSavedSearchToTeamRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.ServiceRepTeams.RequestModels.AddSavedSearchToTeamRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.ServiceRepTeams.RequestModels.AddSavedSearchToTeamRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.ServiceRepTeams.RequestModels.AddSavedSearchToTeamRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.ServiceRepTeams.RequestModels.AddSavedSearchToTeamRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.ServiceRepTeams.RequestModels.AddSavedSearchToTeamRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.ServiceRepTeams.RequestModels.AddSavedSearchToTeamRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.ServiceRepTeams.RequestModels.AddSavedSearchToTeamRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created"
}
}
}
},
"/Teams/{id}/savedSearches/{savedSearchId}": {
"delete": {
"tags": [
"Teams"
],
"summary": "Remove Team Saved Search",
"description": "Revokes a saved search from a Team.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "TeamsByIdSavedSearchesBySavedSearchIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the Team",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "savedSearchId",
"in": "path",
"description": "The Id of the saved search to revoke",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Teams/{id}/settings": {
"delete": {
"tags": [
"Teams"
],
"summary": "Delete All Team Settings",
"description": "Deletes all team settings.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): team-settings-write ````",
"operationId": "TeamsByIdSettingsDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the team.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"204": {
"description": "Settings have been deleted successfully"
}
}
}
},
"/Teams/{id}/settings/{objectName}": {
"get": {
"tags": [
"Teams"
],
"summary": "Get Team Settings",
"description": "Returns the specified settings for the specified team.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "TeamsByIdSettingsByObjectNameGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the team.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "objectName",
"in": "path",
"description": "The name of the specified setting. The name is case insensitive.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"204": {
"description": "No Content, if specified settings are null, whitespace or cannot be found."
}
}
},
"post": {
"tags": [
"Teams"
],
"summary": "Create/Update Team Settings",
"description": "Creates or Updated the specified team settings.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): team-settings-write ````",
"operationId": "TeamsByIdSettingsByObjectNamePost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the team.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "objectName",
"in": "path",
"description": "The name of the specified setting. All alpha characters on object name will be converted to lower case letters.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The content to store. The entire body of the request will be stored. Any value or object is valid except for whitespace.",
"content": {
"application/vnd.textus+jsonld": {
"schema": { },
"example": [{"value":"SampleNote","path":"/PayrollNote","op":"replace"},{"value":50.0,"path":"/OneTimeOverrideRegionWithholding","op":"add"},{"path":"/OneTimeOverrideRegionWithholding","op":"remove"},{"path":"/PayrollNote","op":"copy","from":"/DateWorked"},{"path":"/PayrollNote","op":"move","from":"/DateWorked"},{"value":"SampleNote","path":"/PayrollNote","op":"test"}]
},
"application/json-patch+json": {
"schema": { },
"example": [{"value":"SampleNote","path":"/PayrollNote","op":"replace"},{"value":50.0,"path":"/OneTimeOverrideRegionWithholding","op":"add"},{"path":"/OneTimeOverrideRegionWithholding","op":"remove"},{"path":"/PayrollNote","op":"copy","from":"/DateWorked"},{"path":"/PayrollNote","op":"move","from":"/DateWorked"},{"value":"SampleNote","path":"/PayrollNote","op":"test"}]
},
"application/json": {
"schema": { },
"example": [{"value":"SampleNote","path":"/PayrollNote","op":"replace"},{"value":50.0,"path":"/OneTimeOverrideRegionWithholding","op":"add"},{"path":"/OneTimeOverrideRegionWithholding","op":"remove"},{"path":"/PayrollNote","op":"copy","from":"/DateWorked"},{"path":"/PayrollNote","op":"move","from":"/DateWorked"},{"value":"SampleNote","path":"/PayrollNote","op":"test"}]
},
"text/json": {
"schema": { },
"example": [{"value":"SampleNote","path":"/PayrollNote","op":"replace"},{"value":50.0,"path":"/OneTimeOverrideRegionWithholding","op":"add"},{"path":"/OneTimeOverrideRegionWithholding","op":"remove"},{"path":"/PayrollNote","op":"copy","from":"/DateWorked"},{"path":"/PayrollNote","op":"move","from":"/DateWorked"},{"value":"SampleNote","path":"/PayrollNote","op":"test"}]
},
"application/*+json": {
"schema": { },
"example": [{"value":"SampleNote","path":"/PayrollNote","op":"replace"},{"value":50.0,"path":"/OneTimeOverrideRegionWithholding","op":"add"},{"path":"/OneTimeOverrideRegionWithholding","op":"remove"},{"path":"/PayrollNote","op":"copy","from":"/DateWorked"},{"path":"/PayrollNote","op":"move","from":"/DateWorked"},{"value":"SampleNote","path":"/PayrollNote","op":"test"}]
},
"application/xml": {
"schema": { },
"example": "\r\n \r\n \r\n replace\r\n /PayrollNote\r\n SampleNote\r\n \r\n \r\n \r\n add\r\n /OneTimeOverrideRegionWithholding\r\n 50\r\n \r\n \r\n \r\n remove\r\n /OneTimeOverrideRegionWithholding\r\n \r\n \r\n \r\n /DateWorked\r\n copy\r\n /PayrollNote\r\n \r\n \r\n \r\n /DateWorked\r\n move\r\n /PayrollNote\r\n \r\n \r\n \r\n \r\n test\r\n /PayrollNote\r\n SampleNote\r\n \r\n"
},
"text/xml": {
"schema": { },
"example": "\r\n \r\n \r\n replace\r\n /PayrollNote\r\n SampleNote\r\n \r\n \r\n \r\n add\r\n /OneTimeOverrideRegionWithholding\r\n 50\r\n \r\n \r\n \r\n remove\r\n /OneTimeOverrideRegionWithholding\r\n \r\n \r\n \r\n /DateWorked\r\n copy\r\n /PayrollNote\r\n \r\n \r\n \r\n /DateWorked\r\n move\r\n /PayrollNote\r\n \r\n \r\n \r\n \r\n test\r\n /PayrollNote\r\n SampleNote\r\n \r\n"
},
"application/*+xml": {
"schema": { },
"example": "\r\n \r\n \r\n replace\r\n /PayrollNote\r\n SampleNote\r\n \r\n \r\n \r\n add\r\n /OneTimeOverrideRegionWithholding\r\n 50\r\n \r\n \r\n \r\n remove\r\n /OneTimeOverrideRegionWithholding\r\n \r\n \r\n \r\n /DateWorked\r\n copy\r\n /PayrollNote\r\n \r\n \r\n \r\n /DateWorked\r\n move\r\n /PayrollNote\r\n \r\n \r\n \r\n \r\n test\r\n /PayrollNote\r\n SampleNote\r\n \r\n"
}
}
},
"responses": {
"204": {
"description": "Settings have been saved successfully"
}
}
},
"delete": {
"tags": [
"Teams"
],
"summary": "Delete Team Setting",
"description": "Deletes the specified team setting.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): team-settings-write ````",
"operationId": "TeamsByIdSettingsByObjectNameDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of the team.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "objectName",
"in": "path",
"description": "The name of the specified setting. The object name is case insensitive.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Settings have been deleted successfully"
}
}
}
},
"/Text/CellPhone": {
"get": {
"tags": [
"Texting"
],
"summary": "Get cell phone numbers for given entities.",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): allow-zipwhip ````",
"operationId": "TextCellPhoneGet",
"parameters": [
{
"name": "originTypeId",
"in": "query",
"description": "The origin type associated with supplied originIds.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "originIds",
"in": "query",
"description": "The origin IDs to obtain cell phone numbers for.",
"required": true,
"style": "form",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
}
],
"responses": {
"200": {
"description": "Request Processed"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/Text/Message/Receive": {
"post": {
"tags": [
"Texting"
],
"summary": "Incoming Webhook",
"description": "Allows the vendor to post back the result of a previous send request. \r\nBody sent with endpoint is defined by ZipWhip. Note that TempWorks uses \r\nonly the properties marked as required. This method will always return a 200 status code on bad requests. \r\nYou will need to review the response.HasError for more info.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): allow-zipwhip ````",
"operationId": "TextMessageReceivePost",
"requestBody": {
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.ZipWhip.API.Models.ReceiveMessageRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.ZipWhip.API.Models.ReceiveMessageRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.ZipWhip.API.Models.ReceiveMessageRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.ZipWhip.API.Models.ReceiveMessageRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.ZipWhip.API.Models.ReceiveMessageRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.ZipWhip.API.Models.ReceiveMessageRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.ZipWhip.API.Models.ReceiveMessageRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.ZipWhip.API.Models.ReceiveMessageRequest"
}
}
}
},
"responses": {
"200": {
"description": "Request Processed",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.ZipWhip.v1.ReceiveTextMessageCommand.Response"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.ZipWhip.v1.ReceiveTextMessageCommand.Response"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.ZipWhip.v1.ReceiveTextMessageCommand.Response"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.ZipWhip.v1.ReceiveTextMessageCommand.Response"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.ZipWhip.v1.ReceiveTextMessageCommand.Response"
}
}
}
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/Text/Message/Send": {
"post": {
"tags": [
"Texting"
],
"summary": "Send text message",
"description": "Send text message to one or more phone numbers.\r\nThis will attempt to send messages to all recipients\r\nand will return a 200 even if there are errors from ZipWhip.\r\nThe response data includes error messages returned by ZipWhip.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): allow-zipwhip ````",
"operationId": "TextMessageSendPost",
"requestBody": {
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.ZipWhip.API.Models.SendMessageRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.ZipWhip.API.Models.SendMessageRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.ZipWhip.API.Models.SendMessageRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.ZipWhip.API.Models.SendMessageRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.ZipWhip.API.Models.SendMessageRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.ZipWhip.API.Models.SendMessageRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.ZipWhip.API.Models.SendMessageRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.ZipWhip.API.Models.SendMessageRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.ZipWhip.v1.SendTextMessageCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.ZipWhip.v1.SendTextMessageCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.ZipWhip.v1.SendTextMessageCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.ZipWhip.v1.SendTextMessageCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.ZipWhip.v1.SendTextMessageCommand.Result"
}
}
}
}
}
}
},
"/Text/Message/SessionKey": {
"post": {
"tags": [
"Texting"
],
"summary": "Create ZipWhip session key",
"description": "Required in order to send text messages\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): allow-zipwhip ````",
"operationId": "TextMessageSessionKeyPost",
"requestBody": {
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.ZipWhip.API.Models.CreateSessionKeyRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.ZipWhip.API.Models.CreateSessionKeyRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.ZipWhip.API.Models.CreateSessionKeyRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.ZipWhip.API.Models.CreateSessionKeyRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.ZipWhip.API.Models.CreateSessionKeyRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.ZipWhip.API.Models.CreateSessionKeyRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.ZipWhip.API.Models.CreateSessionKeyRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.ZipWhip.API.Models.CreateSessionKeyRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.ZipWhip.v1.CreateTextSessionKeyCommand.Response"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.ZipWhip.v1.CreateTextSessionKeyCommand.Response"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.ZipWhip.v1.CreateTextSessionKeyCommand.Response"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.ZipWhip.v1.CreateTextSessionKeyCommand.Response"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.ZipWhip.v1.CreateTextSessionKeyCommand.Response"
}
}
}
}
}
}
},
"/Text/Message/SessionKey/{sessionKey}": {
"delete": {
"tags": [
"Texting"
],
"summary": "Delete a ZipWhip session key",
"description": "Delete an existing ZipWhip session key and unsubscribe from any web hooks\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): allow-zipwhip ````",
"operationId": "TextMessageSessionKeyBySessionKeyDelete",
"parameters": [
{
"name": "sessionKey",
"in": "path",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Texting/Assignment/Contacts": {
"post": {
"tags": [
"Texting"
],
"summary": "Get the contacts in the specified contact role for the specified assignments.",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): textmessage-read ````",
"operationId": "TextingAssignmentContactsPost",
"requestBody": {
"description": "A request containing the assignmentIds and the contact role to get the contacts for.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.API.Models.AssignmentContactsRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.API.Models.AssignmentContactsRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.API.Models.AssignmentContactsRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.API.Models.AssignmentContactsRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.API.Models.AssignmentContactsRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.API.Models.AssignmentContactsRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.API.Models.AssignmentContactsRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.API.Models.AssignmentContactsRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
},
"text/csv": {
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
}
}
}
}
}
},
"/Texting/metadata/{externalServiceId}": {
"get": {
"tags": [
"Texting"
],
"summary": "Check Texting Service Metadata",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): textmessage-write ````",
"operationId": "TextingMetadataByExternalServiceIdGet",
"parameters": [
{
"name": "externalServiceId",
"in": "path",
"description": "The Id of the external service being used.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.TextingMetadata.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.TextingMetadata.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.TextingMetadata.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.TextingMetadata.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.TextingMetadata.Result"
}
}
}
}
}
}
},
"/Texting/oneToOneConversation/{externalServiceId}": {
"post": {
"tags": [
"Texting"
],
"summary": "Start a one to one conversation.",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): textmessage-read ````",
"operationId": "TextingOneToOneConversationByExternalServiceIdPost",
"parameters": [
{
"name": "externalServiceId",
"in": "path",
"description": "The Id of the external service being used.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.GetConversationPortalUrl.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.GetConversationPortalUrl.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.GetConversationPortalUrl.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.GetConversationPortalUrl.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.GetConversationPortalUrl.Result"
}
}
}
}
}
}
},
"/Texting/OneToOneConversationData": {
"post": {
"tags": [
"Texting"
],
"summary": "Get recipient data for given entities.",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): textmessage-read ````",
"operationId": "TextingOneToOneConversationDataPost",
"requestBody": {
"description": "A request containing the originid to gather data for and how to filter the data.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.API.Models.OneToOneConversationDataRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.API.Models.OneToOneConversationDataRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.API.Models.OneToOneConversationDataRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.API.Models.OneToOneConversationDataRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.API.Models.OneToOneConversationDataRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.API.Models.OneToOneConversationDataRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.API.Models.OneToOneConversationDataRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.API.Models.OneToOneConversationDataRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.OneToOneConversationData.Result"
}
}
},
"text/csv": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.OneToOneConversationData.Result"
}
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.OneToOneConversationData.Result"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.OneToOneConversationData.Result"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.OneToOneConversationData.Result"
}
}
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.OneToOneConversationData.Result"
}
}
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.OneToOneConversationData.Result"
}
}
}
}
}
}
}
},
"/Texting/RecipientData": {
"post": {
"tags": [
"Texting"
],
"summary": "Get recipient data for given entities.",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): textmessage-read ````",
"operationId": "TextingRecipientDataPost",
"requestBody": {
"description": "A request containing the originids to gather data for and how to filter the data.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.API.Models.RecipientDataRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.API.Models.RecipientDataRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.API.Models.RecipientDataRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.API.Models.RecipientDataRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.API.Models.RecipientDataRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.API.Models.RecipientDataRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.API.Models.RecipientDataRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.API.Models.RecipientDataRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.RecipientData.Result"
}
}
},
"text/csv": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.RecipientData.Result"
}
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.RecipientData.Result"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.RecipientData.Result"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.RecipientData.Result"
}
}
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.RecipientData.Result"
}
}
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.RecipientData.Result"
}
}
}
}
}
}
}
},
"/Texting/Send": {
"post": {
"tags": [
"Texting"
],
"summary": "Send Text Message",
"description": "Send text message to one or more recipients via the request Texting External Service. Currently supported\r\nservice(s) are ZipWhip (11), TextUs(17), and Text-Em-All(14). This endpoint will perform some basic validation on the recipients before\r\naccepting the request and offloading it for background processing. The endpoint returns a BatchJobId that\r\ncan be used to track the process of the background process via the Get Batch Job Details and other associated\r\nBatch Job endpoint, except where a single-sign-on paradigm is used (Text-Em-All).\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): textmessage-write ````",
"operationId": "TextingSendPost",
"requestBody": {
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.API.Models.MessageSendRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.API.Models.MessageSendRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.API.Models.MessageSendRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.API.Models.MessageSendRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.API.Models.MessageSendRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.API.Models.MessageSendRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.API.Models.MessageSendRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.API.Models.MessageSendRequest"
}
}
}
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.SendTextMessageCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.SendTextMessageCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.SendTextMessageCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.SendTextMessageCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.SendTextMessageCommand.Result"
}
}
}
}
}
}
},
"/Texting/Sense/{id}/CustomDataMapping": {
"put": {
"tags": [
"Sense"
],
"summary": "Update Custom Field Mapping.",
"description": "Update a mapping between a Sense custom field and property definition.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): Reserved For TempWorks' Products Only ````",
"operationId": "TextingSenseByIdCustomDataMappingPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The id of specific mapping row",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The Custom Data Field Mapping data to insert.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.API.Models.UpdateSenseCustomDataFieldMappingRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.API.Models.UpdateSenseCustomDataFieldMappingRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.API.Models.UpdateSenseCustomDataFieldMappingRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.API.Models.UpdateSenseCustomDataFieldMappingRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.API.Models.UpdateSenseCustomDataFieldMappingRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.API.Models.UpdateSenseCustomDataFieldMappingRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.API.Models.UpdateSenseCustomDataFieldMappingRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.API.Models.UpdateSenseCustomDataFieldMappingRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Texting/Sense/CustomDataMapping": {
"get": {
"tags": [
"Sense"
],
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): Reserved For TempWorks' Products Only ````",
"operationId": "TextingSenseCustomDataMappingGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "Number of items to skip. Used for paging",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "Number items to take. Used for paging",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.TextingMetadata.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.TextingMetadata.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.TextingMetadata.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.TextingMetadata.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.TextingMetadata.Result"
}
}
}
}
}
},
"post": {
"tags": [
"Sense"
],
"summary": "Creates Custom Field Mapping.",
"description": "Creates a mapping between a Sense custom field and property definition.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): Reserved For TempWorks' Products Only ````",
"operationId": "TextingSenseCustomDataMappingPost",
"requestBody": {
"description": "The Custom Data Field Mapping data to insert.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.API.Models.CreateSenseCustomDataFieldMappingRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.API.Models.CreateSenseCustomDataFieldMappingRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.API.Models.CreateSenseCustomDataFieldMappingRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.API.Models.CreateSenseCustomDataFieldMappingRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.API.Models.CreateSenseCustomDataFieldMappingRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.API.Models.CreateSenseCustomDataFieldMappingRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.API.Models.CreateSenseCustomDataFieldMappingRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.API.Models.CreateSenseCustomDataFieldMappingRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.Sense.CreateSenseCustomDataFieldMapping.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.Sense.CreateSenseCustomDataFieldMapping.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.Sense.CreateSenseCustomDataFieldMapping.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.Sense.CreateSenseCustomDataFieldMapping.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.Sense.CreateSenseCustomDataFieldMapping.Result"
}
}
}
}
}
}
},
"/Texting/Sense/CustomDataMapping/{id}": {
"get": {
"tags": [
"Sense"
],
"summary": "Get Custom Data Mapping By Id",
"description": "Gets the custom data mapping for the specified mapped row.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): employee-read or employee-write ````",
"operationId": "TextingSenseCustomDataMappingByIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the mapping record",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.Sense.SenseFieldMappingById.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.Sense.SenseFieldMappingById.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.Sense.SenseFieldMappingById.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.Sense.SenseFieldMappingById.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.Sense.SenseFieldMappingById.Result"
}
}
}
}
}
}
},
"/Texting/Sense/CustomDataMapping/{senseCustomDataFieldMappingId}": {
"delete": {
"tags": [
"Sense"
],
"summary": "Deletes a custom data field mapping.",
"description": "Deletes a mapping between a Sense custom field and property definition.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): Reserved For TempWorks' Products Only ````",
"operationId": "TextingSenseCustomDataMappingBySenseCustomDataFieldMappingIdDelete",
"parameters": [
{
"name": "senseCustomDataFieldMappingId",
"in": "path",
"description": "The Sense Custom Data Field Mapping Id to be deleted.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Texting/webhook/{externalServiceId}": {
"post": {
"tags": [
"Texting"
],
"summary": "Log webhook payload information.",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): textmessage-webhook ````",
"operationId": "TextingWebhookByExternalServiceIdPost",
"parameters": [
{
"name": "externalServiceId",
"in": "path",
"description": "The Id of the external service being used.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "SRIdent",
"in": "query",
"description": "",
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The data received from the API.",
"content": {
"application/json": {
"schema": { },
"example": [{"value":"SampleNote","path":"/PayrollNote","op":"replace"},{"value":50.0,"path":"/OneTimeOverrideRegionWithholding","op":"add"},{"path":"/OneTimeOverrideRegionWithholding","op":"remove"},{"path":"/PayrollNote","op":"copy","from":"/DateWorked"},{"path":"/PayrollNote","op":"move","from":"/DateWorked"},{"value":"SampleNote","path":"/PayrollNote","op":"test"}]
},
"application/vnd.textus+jsonld": {
"schema": { },
"example": [{"value":"SampleNote","path":"/PayrollNote","op":"replace"},{"value":50.0,"path":"/OneTimeOverrideRegionWithholding","op":"add"},{"path":"/OneTimeOverrideRegionWithholding","op":"remove"},{"path":"/PayrollNote","op":"copy","from":"/DateWorked"},{"path":"/PayrollNote","op":"move","from":"/DateWorked"},{"value":"SampleNote","path":"/PayrollNote","op":"test"}]
}
}
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.WebhookDataCommand.ITextingWebhookResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.WebhookDataCommand.ITextingWebhookResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.WebhookDataCommand.ITextingWebhookResult"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.WebhookDataCommand.ITextingWebhookResult"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Texting.Service.Commands.WebhookDataCommand.ITextingWebhookResult"
}
}
}
}
}
}
},
"/Timecards/incomplete": {
"get": {
"tags": [
"Timecards"
],
"summary": "Get Incomplete Timecards.",
"description": "Returns information about all incomplete timecards.\r\nAn incomplete timecard is such, if it hasn't yet been posted, has a linked document or an open proofing session or is a WebCenter timecard.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): payroll-read ````",
"operationId": "TimecardsIncompleteGet",
"parameters": [
{
"name": "SrIdent",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "WeekendBill",
"in": "query",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "EmployeeId",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "CustomerId",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "AssignmentId",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "TimecardId",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "ProofingSessionId",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "WeekendDate",
"in": "query",
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "BranchId",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "JobOrderId",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "Invoiced",
"in": "query",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "Linked",
"in": "query",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "Proofed",
"in": "query",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "Paid",
"in": "query",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "WebCenter",
"in": "query",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "OrderBy",
"in": "query",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "OrderByAscending",
"in": "query",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "Skip",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Take",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Proofing.GetIncompleteTimecards.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Proofing.GetIncompleteTimecards.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Proofing.GetIncompleteTimecards.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Proofing.GetIncompleteTimecards.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Proofing.GetIncompleteTimecards.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Proofing.GetIncompleteTimecards.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Proofing.GetIncompleteTimecards.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Timecards/nonBillable": {
"get": {
"tags": [
"Timecards"
],
"summary": "Get Non Billable Timecards.",
"description": "Returns information about all non billable timecards.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): payroll-read ````",
"operationId": "TimecardsNonBillableGet",
"parameters": [
{
"name": "skip",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Proofing.GetNonBillableTimecards.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Proofing.GetNonBillableTimecards.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Proofing.GetNonBillableTimecards.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Proofing.GetNonBillableTimecards.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Proofing.GetNonBillableTimecards.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Proofing.GetNonBillableTimecards.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Proofing.GetNonBillableTimecards.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Timecards/nonPayable": {
"get": {
"tags": [
"Timecards"
],
"summary": "Get Non Payable Timecards.",
"description": "Returns timecards that are eligible to be marked or unmarked as non-payable.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): payroll-read ````",
"operationId": "TimecardsNonPayableGet",
"parameters": [
{
"name": "skip",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Proofing.GetNonPayableTimecards.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Proofing.GetNonPayableTimecards.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Proofing.GetNonPayableTimecards.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Proofing.GetNonPayableTimecards.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Proofing.GetNonPayableTimecards.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Proofing.GetNonPayableTimecards.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Proofing.GetNonPayableTimecards.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Timeclock/Employees/{employeeGuid}/Assignments/{assignmentGuid}/punchesByDay": {
"get": {
"tags": [
"Timeclock"
],
"summary": "Get Assignment On-Site Time Clock Punches Grouped by Day",
"description": "Gets a list of punches for the specified assignment grouped by punch day(based on the local punch time). The list is ordered from the most recent to least recent day.\n \n```` Allows roles: ServiceRep, WebUserEmployee, Service ````\n \n```` Requires scope(s): timeclock-read ````",
"operationId": "TimeclockEmployeesByEmployeeGuidAssignmentsByAssignmentGuidPunchesByDayGet",
"parameters": [
{
"name": "employeeGuid",
"in": "path",
"description": "The Guid of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "assignmentGuid",
"in": "path",
"description": "The Guid of the assignment.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "startDate",
"in": "query",
"description": "Start date filter on the punch day(based on the local punch time). Any punch created on or after the date supplied will be returned.",
"required": true,
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "endDate",
"in": "query",
"description": "End date filter on the punch day(based on the local punch time). Any punch created before the date supplied will be returned.",
"required": true,
"style": "form",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "payCodeId",
"in": "query",
"description": "Optional pay code Id filter on the punch pay code Id. If supplied, any punch having the supplied pay code Id will be returned. \r\nOtherwise, all punches would be returned regardless their associated pay code Id.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "costCode",
"in": "query",
"description": "Optional cost code filter on the punch cost code. If supplied, any punch that have the given cost code or does not have associated cost code will be returned. \r\nOtherwise, all punches would be returned regardless their associated cost code.",
"style": "form",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Messages.Timeclock.PunchListByDayQuery.Result"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Messages.Timeclock.PunchListByDayQuery.Result"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Messages.Timeclock.PunchListByDayQuery.Result"
}
}
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Messages.Timeclock.PunchListByDayQuery.Result"
}
}
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Messages.Timeclock.PunchListByDayQuery.Result"
}
}
}
}
}
}
}
},
"/Timeclock/Employees/{employeeId}/Assignments": {
"get": {
"tags": [
"Timeclock"
],
"summary": "Get On-Site Time Clock Assignments",
"description": "Gets a list of assignments available for punching.\n \n```` Allows roles: ServiceRep, WebUserEmployee ````\n \n```` Requires scope(s): timeclock-read ````",
"operationId": "TimeclockEmployeesByEmployeeIdAssignmentsGet",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "phonePunchable",
"in": "query",
"description": "An optional parameter.\r\nFilters assignments on whether or not punches can be made based on if they are enabled for phone punching based on WebCenter configurations.",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "skip",
"in": "query",
"description": "Number of assignments to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "Number of assignments to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Timeclock.Service.Commands.TimeclockPhoneAssignmentsSummariesQuery.Result, Timeclock.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Timeclock.Service.Commands.TimeclockPhoneAssignmentsSummariesQuery.Result, Timeclock.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Timeclock.Service.Commands.TimeclockPhoneAssignmentsSummariesQuery.Result, Timeclock.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Timeclock.Service.Commands.TimeclockPhoneAssignmentsSummariesQuery.Result, Timeclock.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Timeclock.Service.Commands.TimeclockPhoneAssignmentsSummariesQuery.Result, Timeclock.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Timeclock.Service.Commands.TimeclockPhoneAssignmentsSummariesQuery.Result, Timeclock.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Timeclock.Service.Commands.TimeclockPhoneAssignmentsSummariesQuery.Result, Timeclock.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/TimeEntry/adjustments": {
"get": {
"tags": [
"TimeEntry"
],
"summary": "Get Adjustments",
"description": "Get a list of adjustments that can be added on a timecard.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): time-entry-read or time-entry-write ````",
"operationId": "TimeEntryAdjustmentsGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.TimeEntry.GetAdjustmentsForTimecards.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.TimeEntry.GetAdjustmentsForTimecards.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.TimeEntry.GetAdjustmentsForTimecards.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.TimeEntry.GetAdjustmentsForTimecards.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.TimeEntry.GetAdjustmentsForTimecards.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.TimeEntry.GetAdjustmentsForTimecards.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.TimeEntry.GetAdjustmentsForTimecards.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/TimeEntry/adjustments/{adjustmentId}": {
"get": {
"tags": [
"TimeEntry"
],
"summary": "Get Adjustment",
"description": "Get details about the adjustment that can be added on a timecard.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): time-entry-read or time-entry-write ````",
"operationId": "TimeEntryAdjustmentsByAdjustmentIdGet",
"parameters": [
{
"name": "adjustmentId",
"in": "path",
"description": "The Id of the adjustment.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetAdjustmentsForTimecards.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetAdjustmentsForTimecards.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetAdjustmentsForTimecards.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetAdjustmentsForTimecards.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetAdjustmentsForTimecards.Result"
}
}
}
}
}
}
},
"/TimeEntry/createTimecardsRuns/{id}/status": {
"get": {
"tags": [
"TimeEntry"
],
"summary": "Get Create Timecards Run Status",
"description": "Returns the current status of the Create Timecards Run.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): time-entry-write ````",
"operationId": "TimeEntryCreateTimecardsRunsByIdStatusGet",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "The status of the Create Timecards Run.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetCreateTimecardRunStatus.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetCreateTimecardRunStatus.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetCreateTimecardRunStatus.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetCreateTimecardRunStatus.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetCreateTimecardRunStatus.Result"
}
}
}
}
}
}
},
"/TimeEntry/proofing/metadata": {
"get": {
"tags": [
"TimeEntry"
],
"summary": "Get proofing metadata.",
"description": "Returns metadata information about the timecards proofing.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): payroll-read ````",
"operationId": "TimeEntryProofingMetadataGet",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Proofing.TimecardsProofingMetadata.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Proofing.TimecardsProofingMetadata.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Proofing.TimecardsProofingMetadata.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Proofing.TimecardsProofingMetadata.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Proofing.TimecardsProofingMetadata.Result"
}
}
}
}
}
}
},
"/TimeEntry/proofing/session": {
"put": {
"tags": [
"TimeEntry"
],
"summary": "Moves existing timecards into the specified proofing session.",
"description": "This endpoint moves a batch of existing timecards into a specific proofing session, based on the provided session id.\r\nIf a timecard is already in another proofing session, it will be removed from the original session and moved to the new session.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): payroll-read ````",
"operationId": "TimeEntryProofingSessionPut",
"requestBody": {
"description": "Contains a list of the timecard ids that will be moved.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.MoveTimecardsRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.MoveTimecardsRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.MoveTimecardsRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.MoveTimecardsRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.MoveTimecardsRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.MoveTimecardsRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.MoveTimecardsRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.MoveTimecardsRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.MoveTimecardsIntoSession.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.MoveTimecardsIntoSession.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.MoveTimecardsIntoSession.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.MoveTimecardsIntoSession.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.MoveTimecardsIntoSession.Result"
}
}
}
}
}
}
},
"/TimeEntry/proofing/sessions": {
"get": {
"tags": [
"TimeEntry"
],
"summary": "Get Proofing Sessions",
"description": "Get all proofing sessions for the specified week if multiple are open, or the current week if a weekId is not provided.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): payroll-read ````",
"operationId": "TimeEntryProofingSessionsGet",
"parameters": [
{
"name": "weekId",
"in": "query",
"description": "The ID of the week for which to retrieve proofing sessions. If not provided, defaults to the current week.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "statusFilter",
"in": "query",
"description": "The status filter to apply. Options are 'RetrieveOnlyOpen', 'RetrieveOnlyClosed', or 'RetrieveAll'.",
"style": "form",
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Enums.ProofingSessionsStatusFilter"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip, for pagination.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to take, for pagination.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Proofing.GetTimecardProofingSessions.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Proofing.GetTimecardProofingSessions.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Proofing.GetTimecardProofingSessions.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Proofing.GetTimecardProofingSessions.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Proofing.GetTimecardProofingSessions.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Proofing.GetTimecardProofingSessions.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Proofing.GetTimecardProofingSessions.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"TimeEntry"
],
"summary": "Create a new proofing session.",
"description": "Creates a new proofing session.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): payroll-write ````",
"operationId": "TimeEntryProofingSessionsPost",
"requestBody": {
"description": "Criteria of the create proofing session request.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateProofingSessionRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateProofingSessionRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateProofingSessionRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateProofingSessionRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateProofingSessionRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateProofingSessionRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateProofingSessionRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateProofingSessionRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Commands.CreateNewProofingSessionCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Commands.CreateNewProofingSessionCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Commands.CreateNewProofingSessionCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Commands.CreateNewProofingSessionCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Commands.CreateNewProofingSessionCommand.Result"
}
}
}
}
}
}
},
"/TimeEntry/proofing/sessions/{id}/end": {
"put": {
"tags": [
"TimeEntry"
],
"summary": "Ends a proofing session.",
"description": "This endpoint is responsible for ending the specified proofing session.\r\nWhen a proofing session is ended, the following actions will occur: \r\n1. If any of the timecards` salary is not approved, the salary would be set to 0.\r\n2. All the proofing session timecards will be marked as proofed. \r\nAs a result, they will not be included in future proofing sessions and cannot be edited.\r\n3. The proofing session will be marked as ended. \r\nAs a result, you will not be able to trigger proofing error generation or make any modifications to the proofing session.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): payroll-write ````",
"operationId": "TimeEntryProofingSessionsByIdEndPut",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Commands.EndProofingSession.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Commands.EndProofingSession.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Commands.EndProofingSession.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Commands.EndProofingSession.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Commands.EndProofingSession.Result"
}
}
}
}
}
}
},
"/TimeEntry/proofing/sessions/{proofingSessionId}": {
"get": {
"tags": [
"TimeEntry"
],
"summary": "Get Proofing Session by ID",
"description": "Retrieves details of the specified proofing session by its ID.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): payroll-read ````",
"operationId": "TimeEntryProofingSessionsByProofingSessionIdGet",
"parameters": [
{
"name": "proofingSessionId",
"in": "path",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Commands.GetProofingSession.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Commands.GetProofingSession.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Commands.GetProofingSession.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Commands.GetProofingSession.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Commands.GetProofingSession.Result"
}
}
}
}
}
}
},
"/TimeEntry/proofing/sessions/{proofingSessionId}/errors": {
"get": {
"tags": [
"TimeEntry"
],
"summary": "Get Timecard Proofing Errors",
"description": "Get all relevant timecard proofing errors for the specified proofing session.\r\nThese errors are generated during session proofing and might not be accurate. \r\nCalling this endpoint will NOT regenerate the proofing session errors.\r\nIn order to update this information, you can call endpoint\r\n`PUT /timecards/proofing/sessions/{proofingSessionId:int}/errors/generate`.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): payroll-read ````",
"operationId": "TimeEntryProofingSessionsByProofingSessionIdErrorsGet",
"parameters": [
{
"name": "proofingSessionId",
"in": "path",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "skip",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Proofing.GetTimecardProofingErrors.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Proofing.GetTimecardProofingErrors.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Proofing.GetTimecardProofingErrors.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Proofing.GetTimecardProofingErrors.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Proofing.GetTimecardProofingErrors.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Proofing.GetTimecardProofingErrors.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Proofing.GetTimecardProofingErrors.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/TimeEntry/proofing/sessions/{proofingSessionId}/errors/approve": {
"put": {
"tags": [
"TimeEntry"
],
"summary": "Approve Timecard Proofing Errors",
"description": "This endpoint approves all relevant timecard proofing errors for the specified proofing session.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): payroll-write ````",
"operationId": "TimeEntryProofingSessionsByProofingSessionIdErrorsApprovePut",
"parameters": [
{
"name": "proofingSessionId",
"in": "path",
"description": "The ID of the proofing session.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.ApproveTimecardProofingSessionErrors.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.ApproveTimecardProofingSessionErrors.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.ApproveTimecardProofingSessionErrors.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.ApproveTimecardProofingSessionErrors.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.ApproveTimecardProofingSessionErrors.Result"
}
}
}
}
}
}
},
"/TimeEntry/proofing/sessions/{proofingSessionId}/errors/generate": {
"put": {
"tags": [
"TimeEntry"
],
"summary": "Generate proofing session proofing errors.",
"description": "This endpoint is responsible for generating proofing errors for the specified proofing session.\r\nThe generated errors are persisted in the database and are NOT returned from this endpoint\r\nafter the generation is completed. The generated proofing errors for a given proofing session\r\ncould be fetched by calling `GET /timecards/proofing/sessions/{proofingSessionId:int}/errors`.\r\nIf you have resolved any of the proofing errors after the generation is completed, \r\nthe errors will not automatically be removed. You would have to explicitly call this endpoint again\r\nwhich would trigger proofing error generation and in turn remove any irrelevant existing errors.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): payroll-write ````",
"operationId": "TimeEntryProofingSessionsByProofingSessionIdErrorsGeneratePut",
"parameters": [
{
"name": "proofingSessionId",
"in": "path",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/TimeEntry/proofing/sessions/{proofingSessionId}/timecards": {
"get": {
"tags": [
"TimeEntry"
],
"summary": "Get timecards for the specified proofing session id with filter parameters.",
"description": "The optional parameter OrderBy can have the following values: \r\nTimecardId, CustomerName, CustomerId, AssignmentId, EmployeeId, EmployeeName, PayCode, \r\nRegularBillRate RegularPayRate, OverTimeHours, EstimatedGross, RegularHours, OvertimeBillRate, OverTimePayRate, \r\nDoubleTimeHours, DoubleTimeBillRate, DoubleTimePayRate.\r\nWhen not supplied default order by EmployeeName.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): payroll-read ````",
"operationId": "TimeEntryProofingSessionsByProofingSessionIdTimecardsGet",
"parameters": [
{
"name": "proofingSessionId",
"in": "path",
"description": "The proofing session identifier.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "EmployeeName",
"in": "query",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "EmployeeId",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "CustomerName",
"in": "query",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "CustomerId",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "TimecardId",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "PayCodeId",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "OrderBy",
"in": "query",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "OrderByAscending",
"in": "query",
"style": "form",
"schema": {
"type": "boolean"
}
},
{
"name": "Skip",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Take",
"in": "query",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Proofing.GetTimecardsByProofingSessionWithFilters.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Proofing.GetTimecardsByProofingSessionWithFilters.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Proofing.GetTimecardsByProofingSessionWithFilters.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Proofing.GetTimecardsByProofingSessionWithFilters.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Proofing.GetTimecardsByProofingSessionWithFilters.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Proofing.GetTimecardsByProofingSessionWithFilters.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Proofing.GetTimecardsByProofingSessionWithFilters.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/TimeEntry/proofing/sessions/{proofingSessionId}/timecards/metadata": {
"get": {
"tags": [
"TimeEntry"
],
"summary": "Get Proofing Session timecards metadata.",
"description": "Retrieves metadata of the specified proofing session`s timecards.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): payroll-read ````",
"operationId": "TimeEntryProofingSessionsByProofingSessionIdTimecardsMetadataGet",
"parameters": [
{
"name": "proofingSessionId",
"in": "path",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Commands.GetProofingSessionTimecardsMetadata.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Commands.GetProofingSessionTimecardsMetadata.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Commands.GetProofingSessionTimecardsMetadata.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Commands.GetProofingSessionTimecardsMetadata.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Commands.GetProofingSessionTimecardsMetadata.Result"
}
}
}
}
}
}
},
"/TimeEntry/proofing/sessions/{sessionId}/splitByHierarchyComparison": {
"post": {
"tags": [
"TimeEntry"
],
"summary": "Split proofing session based on user hierarchy relation.",
"description": "Users are unable to proof timecards that are not related to their current hierarchy level. As a result, this endpoint splits\r\na proofing session into two based on the user's current hierarchy relation. If a timecard's hierarchy level is not related to the service\r\nrep's level, the timecard is transferred to a newly created session. If the timecard's hierarchy level is related or the same as the service rep's level, \r\nthe timecard will remain with the original session.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): payroll-write ````",
"operationId": "TimeEntryProofingSessionsBySessionIdSplitByHierarchyComparisonPost",
"parameters": [
{
"name": "sessionId",
"in": "path",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.SplitSessionByHierarchyComparison.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.SplitSessionByHierarchyComparison.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.SplitSessionByHierarchyComparison.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.SplitSessionByHierarchyComparison.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.SplitSessionByHierarchyComparison.Result"
}
}
}
}
}
}
},
"/TimeEntry/ProofingSessions/WebCenter": {
"post": {
"tags": [
"TimeEntry"
],
"summary": "Create WebCenter proofing session",
"description": "Creates a proofing session and moves all WebCenter timecards into the new proofing session.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): time-entry-write ````",
"operationId": "TimeEntryProofingSessionsWebCenterPost",
"requestBody": {
"description": "Criteria used to define which timecards are pulled into the proofing session. Leave the list of Timecard Ids empty to move all available timecards into a proofing session.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateWebCenterProofingSessionRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateWebCenterProofingSessionRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateWebCenterProofingSessionRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateWebCenterProofingSessionRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateWebCenterProofingSessionRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateWebCenterProofingSessionRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateWebCenterProofingSessionRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateWebCenterProofingSessionRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.MoveWebcenterTimecardsIntoProofingSession.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.MoveWebcenterTimecardsIntoProofingSession.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.MoveWebcenterTimecardsIntoProofingSession.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.MoveWebcenterTimecardsIntoProofingSession.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.MoveWebcenterTimecardsIntoProofingSession.Result"
}
}
}
}
}
}
},
"/TimeEntry/timecards": {
"get": {
"tags": [
"TimeEntry"
],
"summary": "Get Timecards",
"description": "Get a list of current timecards\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): time-entry-read or time-entry-write ````",
"operationId": "TimeEntryTimecardsGet",
"parameters": [
{
"name": "weekendBill",
"in": "query",
"description": "Required. Limits results to only timecards belonging to the weekend bill specified.",
"required": true,
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "timecardId",
"in": "query",
"description": "Limit results to the specified timecard.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "branchId",
"in": "query",
"description": "Limit results to only timecards belonging to the specified branch.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "customerId",
"in": "query",
"description": "Limit results to only timecards belonging to the specified customer.",
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "customerName",
"in": "query",
"description": "Limit the results on only customers with a name like the supplied value.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "departmentName",
"in": "query",
"description": "Limit the results on only departments with a name like the supplied value.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "employeeId",
"in": "query",
"description": "Limit the results on only the specified employee.",
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "employeeName",
"in": "query",
"description": "Limit the results on only employees with a name like the supplied value.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "employeeGovernmentPersonalId",
"in": "query",
"description": "Limit the results on only employees with a government personal identifier like the supplied value.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "jobOrderId",
"in": "query",
"description": "Limit the results on only the specified assignment.",
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "assignmentId",
"in": "query",
"description": "Limit the results on only the specified job order.",
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "worksiteName",
"in": "query",
"description": "Limit the results on only worksites with a name like the supplied value.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "limitToResultsAfterETag",
"in": "query",
"description": "Limit the results on only timecards that have been updated after the specified ETag.",
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging. This number is capped by the configuration TimeEntryMaximumNumberOfResults which defaults to 1000.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecards.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecards.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecards.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecards.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecards.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecards.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecards.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/TimeEntry/timecards/{id}": {
"get": {
"tags": [
"TimeEntry"
],
"summary": "Get Timecard Details",
"description": "Get detailed information about the specified Timecard.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): time-entry-read or time-entry-write ````",
"operationId": "TimeEntryTimecardsByIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the timecard.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardDetails.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardDetails.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardDetails.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardDetails.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardDetails.Result"
}
}
}
}
}
},
"head": {
"tags": [
"TimeEntry"
],
"summary": "Head Timecard Details",
"description": "A HEAD call used to check the ETag of the specified Timecard.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): time-entry-read or time-entry-write ````",
"operationId": "TimeEntryTimecardsByIdHead",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the timecard.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
},
"delete": {
"tags": [
"TimeEntry"
],
"summary": "Delete Timecard",
"description": "Deletes a Timecard and all associated items. \r\n This action is not allowed if the timecard is posted, in an invoice run, in a payroll run, or is a web center timecard in the web approval process.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): time-entry-write ````",
"operationId": "TimeEntryTimecardsByIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the timecard.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
},
"patch": {
"tags": [
"TimeEntry"
],
"summary": "Patch Timecard Details",
"description": "\r\n\r\n Patch detailed information about the specified Timecard.\r\n More information about PATCHING, see https://developer.ontempworks.com/docs/your-request\r\n \r\n\r\n\r\n Valid Patch paths: /AccountCode(string), /BillRate(decimal), /BranchId(int), /CheckDeliveryCode(string), /CostCenter(string), /CustomerExtra1(string), /CustomerExtra2(string), /CustomerExtra3(string), /DateWorked(DateTime?), /Day1TotalHours(decimal), /Day2TotalHours(decimal), /Day3TotalHours(decimal), /Day4TotalHours(decimal), /Day5TotalHours(decimal), /Day6TotalHours(decimal), /Day7TotalHours(decimal), /DoubletimeBillRate(decimal), /DoubletimeHours(decimal), /DoubletimePayRate(decimal), /InvoiceHoldCode(string), /InvoiceText(string), /IsSalaryApproved(bool), /Location(string), /NumberOfDaysWorked(int), /OneTimeDoNotEPay(string), /OneTimeOverrideFederalWithholding(decimal?), /OneTimeOverridePayPeriods(int?), /OneTimeOverrideRegionWithholding(decimal?), /OvertimeBillRate(decimal), /OvertimeHours(decimal), /OvertimePayRate(decimal), /PayCodeId(int), /PayHoldCode(string), /PayPeriodEndDate(DateTime?), /PayPeriodStartDate(DateTime?), /PayRate(decimal), /PayrollNote(string), /PurchaseOrderId(int?), /RegularHours(decimal), /RequireSeparateCheck(bool), /RequisitionNumber(string), /SalaryBillRate(decimal), /SalaryPayRate(decimal), /ShowZeroBillOnInvoice(bool), /SubEntity(string), /UnitBillRate(decimal), /UnitPayRate(decimal), /Units(decimal), /VendorInvoiceNumber(string), /WeekendDate(DateTime), /WorksiteId(int)\r\n \n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): time-entry-write ````",
"operationId": "TimeEntryTimecardsByIdPatch",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the timecard'",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "eTag",
"in": "query",
"description": "When supplied, updates will not be allowed on records that do not match the E-tag supplied. \r\n It is preferred that this value be passed in the Request Header. \r\n Example: ETag: [value]",
"style": "form",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "A Json array of patch operations to be performed.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":"SampleNote","path":"/PayrollNote","op":"replace"},{"value":50.0,"path":"/OneTimeOverrideRegionWithholding","op":"add"},{"path":"/OneTimeOverrideRegionWithholding","op":"remove"},{"path":"/PayrollNote","op":"copy","from":"/DateWorked"},{"path":"/PayrollNote","op":"move","from":"/DateWorked"},{"value":"SampleNote","path":"/PayrollNote","op":"test"}]
},
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":"SampleNote","path":"/PayrollNote","op":"replace"},{"value":50.0,"path":"/OneTimeOverrideRegionWithholding","op":"add"},{"path":"/OneTimeOverrideRegionWithholding","op":"remove"},{"path":"/PayrollNote","op":"copy","from":"/DateWorked"},{"path":"/PayrollNote","op":"move","from":"/DateWorked"},{"value":"SampleNote","path":"/PayrollNote","op":"test"}]
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":"SampleNote","path":"/PayrollNote","op":"replace"},{"value":50.0,"path":"/OneTimeOverrideRegionWithholding","op":"add"},{"path":"/OneTimeOverrideRegionWithholding","op":"remove"},{"path":"/PayrollNote","op":"copy","from":"/DateWorked"},{"path":"/PayrollNote","op":"move","from":"/DateWorked"},{"value":"SampleNote","path":"/PayrollNote","op":"test"}]
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":"SampleNote","path":"/PayrollNote","op":"replace"},{"value":50.0,"path":"/OneTimeOverrideRegionWithholding","op":"add"},{"path":"/OneTimeOverrideRegionWithholding","op":"remove"},{"path":"/PayrollNote","op":"copy","from":"/DateWorked"},{"path":"/PayrollNote","op":"move","from":"/DateWorked"},{"value":"SampleNote","path":"/PayrollNote","op":"test"}]
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":"SampleNote","path":"/PayrollNote","op":"replace"},{"value":50.0,"path":"/OneTimeOverrideRegionWithholding","op":"add"},{"path":"/OneTimeOverrideRegionWithholding","op":"remove"},{"path":"/PayrollNote","op":"copy","from":"/DateWorked"},{"path":"/PayrollNote","op":"move","from":"/DateWorked"},{"value":"SampleNote","path":"/PayrollNote","op":"test"}]
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": "\r\n \r\n \r\n replace\r\n /PayrollNote\r\n SampleNote\r\n \r\n \r\n \r\n add\r\n /OneTimeOverrideRegionWithholding\r\n 50\r\n \r\n \r\n \r\n remove\r\n /OneTimeOverrideRegionWithholding\r\n \r\n \r\n \r\n /DateWorked\r\n copy\r\n /PayrollNote\r\n \r\n \r\n \r\n /DateWorked\r\n move\r\n /PayrollNote\r\n \r\n \r\n \r\n \r\n test\r\n /PayrollNote\r\n SampleNote\r\n \r\n"
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": "\r\n \r\n \r\n replace\r\n /PayrollNote\r\n SampleNote\r\n \r\n \r\n \r\n add\r\n /OneTimeOverrideRegionWithholding\r\n 50\r\n \r\n \r\n \r\n remove\r\n /OneTimeOverrideRegionWithholding\r\n \r\n \r\n \r\n /DateWorked\r\n copy\r\n /PayrollNote\r\n \r\n \r\n \r\n /DateWorked\r\n move\r\n /PayrollNote\r\n \r\n \r\n \r\n \r\n test\r\n /PayrollNote\r\n SampleNote\r\n \r\n"
},
"application/*+xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": "\r\n \r\n \r\n replace\r\n /PayrollNote\r\n SampleNote\r\n \r\n \r\n \r\n add\r\n /OneTimeOverrideRegionWithholding\r\n 50\r\n \r\n \r\n \r\n remove\r\n /OneTimeOverrideRegionWithholding\r\n \r\n \r\n \r\n /DateWorked\r\n copy\r\n /PayrollNote\r\n \r\n \r\n \r\n /DateWorked\r\n move\r\n /PayrollNote\r\n \r\n \r\n \r\n \r\n test\r\n /PayrollNote\r\n SampleNote\r\n \r\n"
}
}
},
"responses": {
"200": {
"description": "Timecard has been updated and the results of GET /timecards/{timecardid} are returned with changes.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardDetails"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardDetails"
}
}
}
},
"409": {
"description": "Conflict. Timecard changed by another user or process.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardDetails"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardDetails"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardDetails"
}
}
}
}
}
}
},
"/TimeEntry/timecards/{id}/copy": {
"post": {
"tags": [
"TimeEntry"
],
"summary": "Create Duplicate Timecard",
"description": "Creates a copy of an existing timecard.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): time-entry-write ````",
"operationId": "TimeEntryTimecardsByIdCopyPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the timecard.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "Optional overrides of values on the new timecard.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateDuplicateTimecardRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateDuplicateTimecardRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateDuplicateTimecardRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateDuplicateTimecardRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateDuplicateTimecardRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateDuplicateTimecardRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateDuplicateTimecardRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateDuplicateTimecardRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardDetails.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardDetails.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardDetails.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardDetails.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardDetails.Result"
}
}
}
}
}
}
},
"/TimeEntry/timecards/{id}/updateFromAssignment": {
"post": {
"tags": [
"TimeEntry"
],
"summary": "Update Timecard Details from Assignment",
"description": "Updates the timecard details from assignment information. The timecard will be updated to the assignment pay and bill rates, unit pay and bill rates, salary pay and bill rates, branchId, shift, and skillcodeId.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): time-entry-write ````",
"operationId": "TimeEntryTimecardsByIdUpdateFromAssignmentPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the timecard.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "returnTimecard",
"in": "query",
"description": "Determines if the details of the timecard are returned after the update. Defaults to false.",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "The updated timecard details. Response occurs when returnTimecard is true.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardDetails.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardDetails.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardDetails.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardDetails.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardDetails.Result"
}
}
}
},
"204": {
"description": "No Content"
}
}
}
},
"/TimeEntry/timecards/{id}/updateFromOrder": {
"post": {
"tags": [
"TimeEntry"
],
"summary": "Update Timecard Details from Order",
"description": "Updates the timecard details from the order information. The timecard will be updated to the order pay and bill rates, branchId, shift, worksiteId and purchase order Id.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): time-entry-write ````",
"operationId": "TimeEntryTimecardsByIdUpdateFromOrderPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the timecard.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "returnTimecard",
"in": "query",
"description": "Determines if the details of the timecard are returned after the update. Defaults to false.",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "The updated timecard details. Response occurs when returnTimecard is true",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardDetails.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardDetails.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardDetails.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardDetails.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardDetails.Result"
}
}
}
},
"204": {
"description": "No Content"
}
}
}
},
"/TimeEntry/timecards/{timecardId}/adjustments": {
"get": {
"tags": [
"TimeEntry"
],
"summary": "Get Timecard Adjustments",
"description": "Get a list of adjustments added to a timecard.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): time-entry-read or time-entry-write ````",
"operationId": "TimeEntryTimecardsByTimecardIdAdjustmentsGet",
"parameters": [
{
"name": "timecardId",
"in": "path",
"description": "The Id of the timecard.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardAdjustments.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardAdjustments.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardAdjustments.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardAdjustments.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardAdjustments.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardAdjustments.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardAdjustments.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"TimeEntry"
],
"summary": "Create Timecard Adjustment",
"description": "Adds an adjustment to the timecard.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): time-entry-write ````",
"operationId": "TimeEntryTimecardsByTimecardIdAdjustmentsPost",
"parameters": [
{
"name": "timecardId",
"in": "path",
"description": "The Id of the timecard.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The body of the request containing information about the new timecard adjustment.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardAdjustmentRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardAdjustmentRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardAdjustmentRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardAdjustmentRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardAdjustmentRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardAdjustmentRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardAdjustmentRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardAdjustmentRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.CreateTimecardAdjustment.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.CreateTimecardAdjustment.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.CreateTimecardAdjustment.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.CreateTimecardAdjustment.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.CreateTimecardAdjustment.Result"
}
}
}
}
}
}
},
"/TimeEntry/timecards/{timecardId}/adjustments/{timecardAdjustmentId}": {
"get": {
"tags": [
"TimeEntry"
],
"summary": "Get Timecard Adjustment",
"description": "Get details about the adjustment added to a timecard.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): time-entry-read or time-entry-write ````",
"operationId": "TimeEntryTimecardsByTimecardIdAdjustmentsByTimecardAdjustmentIdGet",
"parameters": [
{
"name": "timecardId",
"in": "path",
"description": "The Id of the timecard.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "timecardAdjustmentId",
"in": "path",
"description": "The Id of the timecard adjustment.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardAdjustments.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardAdjustments.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardAdjustments.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardAdjustments.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardAdjustments.Result"
}
}
}
}
}
},
"put": {
"tags": [
"TimeEntry"
],
"summary": "Update Timecard Adjustment",
"description": "Update an existing adjustment to the timecard.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): time-entry-write ````",
"operationId": "TimeEntryTimecardsByTimecardIdAdjustmentsByTimecardAdjustmentIdPut",
"parameters": [
{
"name": "timecardId",
"in": "path",
"description": "The Id of the timecard.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "timecardAdjustmentId",
"in": "path",
"description": "The Id of the timecard adjustment.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The body of the request containing updated information about the existing timecard adjustment.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.UpdateTimecardAdjustmentRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.UpdateTimecardAdjustmentRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.UpdateTimecardAdjustmentRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.UpdateTimecardAdjustmentRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.UpdateTimecardAdjustmentRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.UpdateTimecardAdjustmentRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.UpdateTimecardAdjustmentRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.UpdateTimecardAdjustmentRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
},
"delete": {
"tags": [
"TimeEntry"
],
"summary": "Delete Timecard Adjustment",
"description": "Delete an existing adjustment to the timecard.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): time-entry-write ````",
"operationId": "TimeEntryTimecardsByTimecardIdAdjustmentsByTimecardAdjustmentIdDelete",
"parameters": [
{
"name": "timecardId",
"in": "path",
"description": "The Id of the timecard.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "timecardAdjustmentId",
"in": "path",
"description": "The Id of the timecard adjustment.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/TimeEntry/timecards/{timecardId}/adjustments/{timecardAdjustmentId}/document": {
"post": {
"tags": [
"TimeEntry"
],
"summary": "Create Timecard Adjustment Document",
"description": "Adds a document to a timecard adjustment. You can only add one document per timecard adjustment.\r\nThis requires a multipart form-data POST request. \r\nOne part must contain the file to upload and subsequent parts will be used to provide \r\nother data such as documentTypeId.\r\n\r\nFor more information about using formdata, see: https://developer.mozilla.org/en-US/docs/Web/API/FormData/FormData\r\nFor more information about using multipart/form-data, see: http://stackoverflow.com/questions/4526273/what-does-enctype-multipart-form-data-mean\r\nBelow is an example multipart/form-data POST request body:\r\n\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn\r\nContent-Disposition: form-data; name=\"file\"; filename=\"Test.txt\"\r\nContent-Type: text/plain\r\n\r\nThis is where the file content is placed!\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn\r\nContent-Disposition: form-data; name=\"fileName\"\r\n\r\nNewFileName.txt\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn\r\nContent-Disposition: form-data; name=\"expirationDate\"\r\n\r\n2012-12-21\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn\r\nContent-Disposition: form-data; name=\"documentTypeId\"\r\n\r\n1\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn\r\nContent-Disposition: form-data; name=\"version\"\r\n\r\n1\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn\r\nContent-Disposition: form-data; name=\"description\"\r\n\r\ntest\r\n------WebKitFormBoundarynI6DnTBbjAFxI1Cn--\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): time-entry-write ````",
"operationId": "TimeEntryTimecardsByTimecardIdAdjustmentsByTimecardAdjustmentIdDocumentPost",
"parameters": [
{
"name": "timecardId",
"in": "path",
"description": "The Id of the timecard.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "timecardAdjustmentId",
"in": "path",
"description": "The Id of the timecard adjustment.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.CreateTimecardAdjustmentDocument.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.CreateTimecardAdjustmentDocument.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.CreateTimecardAdjustmentDocument.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.CreateTimecardAdjustmentDocument.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.CreateTimecardAdjustmentDocument.Result"
}
}
}
}
}
},
"delete": {
"tags": [
"TimeEntry"
],
"summary": "Delete Timecard Adjustment Document",
"description": "Delete an existing timecard adjustment document.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): time-entry-write ````",
"operationId": "TimeEntryTimecardsByTimecardIdAdjustmentsByTimecardAdjustmentIdDocumentDelete",
"parameters": [
{
"name": "timecardId",
"in": "path",
"description": "The Id of the timecard.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "timecardAdjustmentId",
"in": "path",
"description": "The Id of the timecard adjustment.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/TimeEntry/timecards/{timecardId}/assignmentAdjustments": {
"get": {
"tags": [
"TimeEntry"
],
"summary": "Get Timecard Assignment Adjustments",
"description": "Get a list of assignment adjustments which can be added to a timecard.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): time-entry-read or time-entry-write ````",
"operationId": "TimeEntryTimecardsByTimecardIdAssignmentAdjustmentsGet",
"parameters": [
{
"name": "timecardId",
"in": "path",
"description": "The Id of the timecard.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "returnOnlyUnusedAdjustments",
"in": "query",
"description": "Will only return assignments adjustments not on the timecard when true. Returns all when false. Default is true.",
"style": "form",
"schema": {
"type": "boolean",
"default": true
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardAssignmentAdjustments.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardAssignmentAdjustments.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardAssignmentAdjustments.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardAssignmentAdjustments.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardAssignmentAdjustments.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardAssignmentAdjustments.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardAssignmentAdjustments.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/TimeEntry/timecards/batch/{id}": {
"get": {
"tags": [
"TimeEntry"
],
"summary": "Get Timecard Import Batch Job Status",
"description": "Returns detailed information about the requested Timecard import Batch Job.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): time-entry-write ````",
"operationId": "TimeEntryTimecardsBatchByIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of Batch Job.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardImportStatus.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardImportStatus.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardImportStatus.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardImportStatus.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardImportStatus.Result"
}
}
}
}
}
}
},
"/TimeEntry/timecards/batch/{id}/errors": {
"get": {
"tags": [
"TimeEntry"
],
"summary": "Get Timecard Import Batch Job errors",
"description": "Returns failed records from the requested Timecard import Batch Job.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): time-entry-write ````",
"operationId": "TimeEntryTimecardsBatchByIdErrorsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of Batch Job.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardImportErrors.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardImportErrors.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardImportErrors.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardImportErrors.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardImportErrors.Result"
}
}
}
}
}
}
},
"/TimeEntry/timecards/batch/{id}/update": {
"put": {
"tags": [
"TimeEntry"
],
"summary": "Update Timecard Import Batch Jobs Timecards",
"description": "Updates unprocessed timecards from a batch job and creates new timecards for those that have already been processed.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): time-entry-write ````",
"operationId": "TimeEntryTimecardsBatchByIdUpdatePut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of Batch Job.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardBatchRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardBatchRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardBatchRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardBatchRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardBatchRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardBatchRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardBatchRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardBatchRequest"
}
}
}
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.UpdateTimecardBatch.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.UpdateTimecardBatch.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.UpdateTimecardBatch.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.UpdateTimecardBatch.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.UpdateTimecardBatch.Result"
}
}
}
}
}
}
},
"/TimeEntry/timecards/create": {
"post": {
"tags": [
"TimeEntry"
],
"summary": "Create Timecards",
"description": "Creates timecards for the current open weeks. The request object specifies if timecards are created for the current week or if a timecard needs to be generated for a specific assignment Id.\r\nIf no weekId is supplied, the earliest open week is used. If the database is configured to allow for two open weeks, timecards will be created for all open weeks.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): time-entry-write ````",
"operationId": "TimeEntryTimecardsCreatePost",
"requestBody": {
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardRequest"
}
}
}
},
"responses": {
"200": {
"description": "Timecards have been created.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.CreateTimecards.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.CreateTimecards.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.CreateTimecards.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.CreateTimecards.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.CreateTimecards.Result"
}
}
}
},
"202": {
"description": "The creation of the timecards has been queued. \r\n This result will be returned when the Timecard Generation Type is 0 - CurrentOpenWeeks.\r\n The status of the run may be obtained by reviewing the value of Location in the result header. Ref: timeentry/createTimecardsRuns/{id}/status",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.CreateTimecards.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.CreateTimecards.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.CreateTimecards.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.CreateTimecards.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.CreateTimecards.Result"
}
}
}
}
},
"deprecated": true
}
},
"/TimeEntry/timecards/create/assignment": {
"post": {
"tags": [
"TimeEntry"
],
"summary": "Create Timecard for an assignment.",
"description": "Generate a timecard for a specific assignment Id and optionally set some intial values for the timecard.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): time-entry-write ````",
"operationId": "TimeEntryTimecardsCreateAssignmentPost",
"requestBody": {
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardFromAssignmentRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardFromAssignmentRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardFromAssignmentRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardFromAssignmentRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardFromAssignmentRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardFromAssignmentRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardFromAssignmentRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardFromAssignmentRequest"
}
}
}
},
"responses": {
"200": {
"description": "Timecards have been created.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.CreateTimecardFromAssignment.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.CreateTimecardFromAssignment.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.CreateTimecardFromAssignment.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.CreateTimecardFromAssignment.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.CreateTimecardFromAssignment.Result"
}
}
}
}
}
}
},
"/TimeEntry/timecards/create/batch": {
"post": {
"tags": [
"TimeEntry"
],
"summary": "Create timecard batch job. This will either create timecards with the provided initial values or update unused timecards with those values.",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): time-entry-write ````",
"operationId": "TimeEntryTimecardsCreateBatchPost",
"requestBody": {
"description": "The details of the timecard batch job",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardBatchRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardBatchRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardBatchRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardBatchRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardBatchRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardBatchRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardBatchRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardBatchRequest"
}
}
}
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.CreateTimecardBatch.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.CreateTimecardBatch.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.CreateTimecardBatch.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.CreateTimecardBatch.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.CreateTimecardBatch.Result"
}
}
}
}
}
}
},
"/TimeEntry/timecards/create/validate": {
"post": {
"tags": [
"TimeEntry"
],
"summary": "Validate Create Timecards Request",
"description": "Validates if the user can create timecards.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): time-entry-write ````",
"operationId": "TimeEntryTimecardsCreateValidatePost",
"requestBody": {
"description": "Criteria of the create timecards request.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardRequest"
}
}
}
},
"responses": {
"204": {
"description": "Timecards can be created."
},
"400": {
"description": "Timecards cannot be created and validation errors are returned."
}
}
}
},
"/TimeEntry/timecards/create/week": {
"post": {
"tags": [
"TimeEntry"
],
"summary": "Create Timecards",
"description": "Creates timecards for the current open weeks. If no weekId is supplied, the earliest open week is used. If the database is configured to allow for two open weeks, timecards will be created for all open weeks.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): time-entry-write ````",
"operationId": "TimeEntryTimecardsCreateWeekPost",
"requestBody": {
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardsFromWeekRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardsFromWeekRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardsFromWeekRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardsFromWeekRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardsFromWeekRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardsFromWeekRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardsFromWeekRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardsFromWeekRequest"
}
}
}
},
"responses": {
"202": {
"description": "The creation of the timecards has been queued. \r\n The status of the run may be obtained by reviewing the value of Location in the result header. Ref: timeentry/createTimecardsRuns/{id}/status",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.CreateTimecardsFromWeek.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.CreateTimecardsFromWeek.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.CreateTimecardsFromWeek.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.CreateTimecardsFromWeek.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.CreateTimecardsFromWeek.Result"
}
}
}
}
}
}
},
"/TimeEntry/webtimecards/templates/{id}": {
"get": {
"tags": [
"TimeEntry"
],
"summary": "Get WebTimecard Template Details",
"description": "Get detailed information about the specified web timecard template.\n \n```` Allows roles: ServiceRep, WebUserEmployee ````\n \n```` Requires scope(s): webtimecard-read or webtimecard-write ````",
"operationId": "TimeEntryWebtimecardsTemplatesByIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the web timecard template.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardTemplateDetails.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardTemplateDetails.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardTemplateDetails.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardTemplateDetails.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardTemplateDetails.Result"
}
}
}
}
}
}
},
"/Users": {
"get": {
"tags": [
"Users"
],
"summary": "Get current user's summary information",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "UsersGet",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.Users.GetCurrentServiceRepDetails.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.Users.GetCurrentServiceRepDetails.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.Users.GetCurrentServiceRepDetails.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.Users.GetCurrentServiceRepDetails.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.Users.GetCurrentServiceRepDetails.Result"
}
}
}
}
}
}
},
"/Users/{id}": {
"get": {
"tags": [
"Users"
],
"summary": "Get specified user's summary information",
"description": "Requires ServiceRepRead policy\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): servicerep-read ````",
"operationId": "UsersByIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.Users.ServiceRepQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.Users.ServiceRepQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.Users.ServiceRepQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.Users.ServiceRepQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.Users.ServiceRepQuery.Result"
}
}
}
}
}
}
},
"/Users/{id}/{productInstanceId}/onboarding/secondaryworkflows": {
"get": {
"tags": [
"Users"
],
"summary": "Get User Secondary Onboarding Workflow Instances",
"description": "Gets a list of SecondaryOnboarding Workflow Instances assigned to the User.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): onboarding-read or onboarding-write ````",
"operationId": "UsersByIdByProductInstanceIdOnboardingSecondaryworkflowsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the User.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "productInstanceId",
"in": "path",
"description": "The Id of the Product instance.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "RestrictToActiveSecondayWorkflowInstances",
"in": "query",
"description": "Limits workflow results to active secondary workflows only. \r\n A workflow is considered active if the User is the current actor and the workflow \r\n is not in a completed, submitted, or rejected state.",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetSecondaryWorkflowInstancesList.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetSecondaryWorkflowInstancesList.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetSecondaryWorkflowInstancesList.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetSecondaryWorkflowInstancesList.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetSecondaryWorkflowInstancesList.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetSecondaryWorkflowInstancesList.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetSecondaryWorkflowInstancesList.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Users/{id}/{productInstanceId}/onboarding/secondaryworkflows/{workflowInstanceId}": {
"get": {
"tags": [
"Users"
],
"summary": "Get User Secondary Onboarding Workflow Instance",
"description": "Gets details about the Secondary Onboarding Workflow Instance.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): onboarding-read or onboarding-write ````",
"operationId": "UsersByIdByProductInstanceIdOnboardingSecondaryworkflowsByWorkflowInstanceIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the User.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "productInstanceId",
"in": "path",
"description": "The Id of the Product Instance",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "workflowInstanceId",
"in": "path",
"description": "The Id of the workflow instance.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetSecondaryWorkflowInstancesList.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetSecondaryWorkflowInstancesList.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetSecondaryWorkflowInstancesList.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetSecondaryWorkflowInstancesList.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetSecondaryWorkflowInstancesList.Result"
}
}
}
}
}
}
},
"/users/{id}/{productInstanceId}/onboarding/syncOnboardingData": {
"post": {
"tags": [
"Users"
],
"summary": "Refresh Searchable Workflow and Step Data.",
"description": "\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): onboarding-write ````",
"operationId": "UsersByIdByProductInstanceIdOnboardingSyncOnboardingDataPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the service representative.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "productInstanceId",
"in": "path",
"description": "The Id of the product instance.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Users/{id}/{productInstanceId}/onboarding/workflows": {
"get": {
"tags": [
"Users"
],
"summary": "Get User Onboarding Workflow Instances",
"description": "Gets a list of Onboarding Workflow Instances assigned to the User.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): onboarding-read or onboarding-write ````",
"operationId": "UsersByIdByProductInstanceIdOnboardingWorkflowsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the User.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "productInstanceId",
"in": "path",
"description": "The Id of the Product instance.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
},
{
"name": "RestrictToActiveWorkflowInstances",
"in": "query",
"description": "Limits workflow results to active workflows only. \r\n A workflow is considered active if the User is the current actor and the workflow \r\n is not in a completed, submitted, or rejected state.",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetWorkflowInstanceListQuery.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetWorkflowInstanceListQuery.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetWorkflowInstanceListQuery.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetWorkflowInstanceListQuery.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetWorkflowInstanceListQuery.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetWorkflowInstanceListQuery.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetWorkflowInstanceListQuery.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Users"
],
"summary": "Create User Onboarding Workflow Instance",
"description": "Assigns an Onboarding Workflow to the User.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): onboarding-write ````",
"operationId": "UsersByIdByProductInstanceIdOnboardingWorkflowsPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the User.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "productInstanceId",
"in": "path",
"description": "The Id of the Product Instance",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The body of the request containing information about the new workflow.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.CreateWorkflowInstanceRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.CreateWorkflowInstanceRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.CreateWorkflowInstanceRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.CreateWorkflowInstanceRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.CreateWorkflowInstanceRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.CreateWorkflowInstanceRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.CreateWorkflowInstanceRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.CreateWorkflowInstanceRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.AssignWorkflowCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.AssignWorkflowCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.AssignWorkflowCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.AssignWorkflowCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.AssignWorkflowCommand.Result"
}
}
}
}
}
}
},
"/Users/{id}/{productInstanceId}/onboarding/workflows/{workflowInstanceId}": {
"get": {
"tags": [
"Users"
],
"summary": "Get User Onboarding Workflow Instance",
"description": "Gets details about the Onboarding Workflow Instance.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): onboarding-read or onboarding-write ````",
"operationId": "UsersByIdByProductInstanceIdOnboardingWorkflowsByWorkflowInstanceIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the User.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "productInstanceId",
"in": "path",
"description": "The Id of the Product Instance",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "workflowInstanceId",
"in": "path",
"description": "The Id of the workflow instance.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetWorkflowInstanceListQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetWorkflowInstanceListQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetWorkflowInstanceListQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetWorkflowInstanceListQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetWorkflowInstanceListQuery.Result"
}
}
}
}
}
}
},
"/Users/{id}/{productInstanceId}/onboarding/workflows/{workflowInstanceId}/advance": {
"put": {
"tags": [
"Users"
],
"summary": "Advance Onboarding Workflow Instance to the next Step",
"description": "Advances the Onboarding Workflow to the next Step or marks it as Complete if there is no next Step.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): onboarding-write ````",
"operationId": "UsersByIdByProductInstanceIdOnboardingWorkflowsByWorkflowInstanceIdAdvancePut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "productInstanceId",
"in": "path",
"description": "The Id of the Product Instance",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "workflowInstanceId",
"in": "path",
"description": "The Id of the workflow instance.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "A request that allows you to provide a secondary actor's username",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.AdvanceWorkflowRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.AdvanceWorkflowRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.AdvanceWorkflowRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.AdvanceWorkflowRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.AdvanceWorkflowRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.AdvanceWorkflowRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.AdvanceWorkflowRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.AdvanceWorkflowRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.AdvanceWorkflowInstanceCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.AdvanceWorkflowInstanceCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.AdvanceWorkflowInstanceCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.AdvanceWorkflowInstanceCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.AdvanceWorkflowInstanceCommand.Result"
}
}
}
}
}
}
},
"/Users/{id}/{productInstanceId}/onboarding/workflows/{workflowInstanceId}/reject": {
"put": {
"tags": [
"Users"
],
"summary": "Reject User Onboarding Workflow Instance",
"description": "Rejects the Instance of the Workflow assigned to the Employee.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): onboarding-write ````",
"operationId": "UsersByIdByProductInstanceIdOnboardingWorkflowsByWorkflowInstanceIdRejectPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "productInstanceId",
"in": "path",
"description": "The Id of the Product Instance",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "workflowInstanceId",
"in": "path",
"description": "The Id of the workflow instance to reject.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The body of the request containing the reason the workflow has been rejected.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.RejectWorkflowRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.RejectWorkflowRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.RejectWorkflowRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.RejectWorkflowRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.RejectWorkflowRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.RejectWorkflowRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.RejectWorkflowRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.RejectWorkflowRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Users/{id}/{productInstanceId}/onboarding/workflows/{workflowInstanceId}/singleSignOn": {
"get": {
"tags": [
"Users"
],
"summary": "Creates a url used for single sign on to HrCenter",
"description": "Returns a secure query string that can be used to sign into HrCenter\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): onboarding-write ````",
"operationId": "UsersByIdByProductInstanceIdOnboardingWorkflowsByWorkflowInstanceIdSingleSignOnGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the User.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "productInstanceId",
"in": "path",
"description": "The Id of the Product Instance",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "workflowInstanceId",
"in": "path",
"description": "The Id of the workflow instance.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetSingleSignOnUrlCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetSingleSignOnUrlCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetSingleSignOnUrlCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetSingleSignOnUrlCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetSingleSignOnUrlCommand.Result"
}
}
}
}
}
}
},
"/Users/{id}/{productInstanceId}/onboarding/workflows/{workflowInstanceId}/steps": {
"get": {
"tags": [
"Users"
],
"summary": "Get User Onboarding Step Instances",
"description": "Gets a list of Step Instances for an Onboarding Workflow Instance.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): onboarding-read or onboarding-write ````",
"operationId": "UsersByIdByProductInstanceIdOnboardingWorkflowsByWorkflowInstanceIdStepsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the User.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "productInstanceId",
"in": "path",
"description": "The Id of the Product instance.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "workflowInstanceId",
"in": "path",
"description": "The Id of the workflow instance.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetWorkflowInstanceStepList.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetWorkflowInstanceStepList.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetWorkflowInstanceStepList.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetWorkflowInstanceStepList.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetWorkflowInstanceStepList.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetWorkflowInstanceStepList.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetWorkflowInstanceStepList.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Users/{id}/{productInstanceId}/onboarding/workflows/{workflowInstanceId}/steps/{stepInstanceId}": {
"get": {
"tags": [
"Users"
],
"summary": "Get User Onboarding Step Instance",
"description": "Gets details about the Step Instance.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): onboarding-read or onboarding-write ````",
"operationId": "UsersByIdByProductInstanceIdOnboardingWorkflowsByWorkflowInstanceIdStepsByStepInstanceIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the user.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "productInstanceId",
"in": "path",
"description": "The Id of the Product instance.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "workflowInstanceId",
"in": "path",
"description": "The Id of the workflow instance.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "stepInstanceId",
"in": "path",
"description": "The Id of the step instance.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetWorkflowInstanceStepList.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetWorkflowInstanceStepList.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetWorkflowInstanceStepList.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetWorkflowInstanceStepList.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetWorkflowInstanceStepList.Result"
}
}
}
}
}
},
"put": {
"tags": [
"Users"
],
"summary": "Add Additional Step Instances Pages",
"description": "Adds additional Pages to the Step Instance.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): onboarding-write ````",
"operationId": "UsersByIdByProductInstanceIdOnboardingWorkflowsByWorkflowInstanceIdStepsByStepInstanceIdPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the user.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "productInstanceId",
"in": "path",
"description": "The Id of the Product instance.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "workflowInstanceId",
"in": "path",
"description": "The Id of the workflow instance.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "stepInstanceId",
"in": "path",
"description": "The Id of the step instance.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The body of the request containing the reason the workflow has been rejected.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.AddAdditionalPagesToStepInstanceRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.AddAdditionalPagesToStepInstanceRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.AddAdditionalPagesToStepInstanceRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.AddAdditionalPagesToStepInstanceRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.AddAdditionalPagesToStepInstanceRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.AddAdditionalPagesToStepInstanceRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.AddAdditionalPagesToStepInstanceRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.AddAdditionalPagesToStepInstanceRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Users/{id}/{productInstanceId}/onboarding/workflows/{workflowInstanceId}/steps/{stepInstanceId}/pages": {
"get": {
"tags": [
"Users"
],
"summary": "Get User Onboarding Page Instances",
"description": "Gets a list of Page Instances for the Onboarding Step Instance.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): onboarding-read or onboarding-write ````",
"operationId": "UsersByIdByProductInstanceIdOnboardingWorkflowsByWorkflowInstanceIdStepsByStepInstanceIdPagesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the User.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "productInstanceId",
"in": "path",
"description": "The Id of the product instance.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "workflowInstanceId",
"in": "path",
"description": "The Id of the workflow instance.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "stepInstanceId",
"in": "path",
"description": "The Id of the step instance.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetStepInstancePageInstanceListQuery.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetStepInstancePageInstanceListQuery.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetStepInstancePageInstanceListQuery.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetStepInstancePageInstanceListQuery.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetStepInstancePageInstanceListQuery.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetStepInstancePageInstanceListQuery.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetStepInstancePageInstanceListQuery.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Users/{id}/{productInstanceId}/onboarding/workflows/{workflowInstanceId}/steps/{stepInstanceId}/pages/{pageInstanceId}": {
"get": {
"tags": [
"Users"
],
"summary": "Get User Onboarding Page Instance",
"description": "Gets details about the Onboarding Workflow Page Instance.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): onboarding-read or onboarding-write ````",
"operationId": "UsersByIdByProductInstanceIdOnboardingWorkflowsByWorkflowInstanceIdStepsByStepInstanceIdPagesByPageInstanceIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the user.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "productInstanceId",
"in": "path",
"description": "The Id of the product instance.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "workflowInstanceId",
"in": "path",
"description": "The Id of the workflow instance.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "stepInstanceId",
"in": "path",
"description": "The Id of the step instance.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "pageInstanceId",
"in": "path",
"description": "The Id of the page instance.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetStepInstancePageInstanceListQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetStepInstancePageInstanceListQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetStepInstancePageInstanceListQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetStepInstancePageInstanceListQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetStepInstancePageInstanceListQuery.Result"
}
}
}
}
}
}
},
"/Users/{id}/{productInstanceId}/onboarding/workflows/{workflowInstanceId}/steps/{stepInstanceId}/unlock": {
"put": {
"tags": [
"Users"
],
"summary": "Unlock User Onboarding Workflow Step Instance",
"description": "Allows the Step Instance to be edited again by the User if it has been Submitted but not Completed.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): onboarding-write ````",
"operationId": "UsersByIdByProductInstanceIdOnboardingWorkflowsByWorkflowInstanceIdStepsByStepInstanceIdUnlockPut",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the user.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "productInstanceId",
"in": "path",
"description": "The Id of the Product instance.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "workflowInstanceId",
"in": "path",
"description": "The Id of the workflow instance.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "stepInstanceId",
"in": "path",
"description": "The Id of the step instance.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Users/{id}/permissions": {
"get": {
"tags": [
"Users"
],
"summary": "Get User Permissions List",
"description": "Returns the list of permissions that the user has been granted via their security group. The list is ordered by the permission name.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "UsersByIdPermissionsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the service rep",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of permissions to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of permissions to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Users.UserPermissionsListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Users.UserPermissionsListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Users.UserPermissionsListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Users.UserPermissionsListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Users.UserPermissionsListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Users.UserPermissionsListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Users.UserPermissionsListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Users/{id}/productInstances": {
"get": {
"tags": [
"Users"
],
"summary": "Get Product Instances for a User",
"description": "Gets a list of Product Instances a User has access to.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "UsersByIdProductInstancesGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the User.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "productId",
"in": "query",
"description": "Optional filter using the Id of the product.",
"style": "form",
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Enums.Products"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.WebUserAccountProductInstanceListByOriginPairQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.WebUserAccountProductInstanceListByOriginPairQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.WebUserAccountProductInstanceListByOriginPairQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.WebUserAccountProductInstanceListByOriginPairQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.WebUserAccountProductInstanceListByOriginPairQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.WebUserAccountProductInstanceListByOriginPairQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.WebUserAccountProductInstanceListByOriginPairQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Users/{id}/securityGroups": {
"get": {
"tags": [
"Users"
],
"summary": "Get User Security Groups List",
"description": "Returns the list of security groups that the user is a member of.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "UsersByIdSecurityGroupsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the service rep to query",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Users.UserSecurityGroupsQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Users.UserSecurityGroupsQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Users.UserSecurityGroupsQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Users.UserSecurityGroupsQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Users.UserSecurityGroupsQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Users.UserSecurityGroupsQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Users.UserSecurityGroupsQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Users"
],
"summary": "Set Security Group for user",
"description": "Add user to security group. Automatically removes user from an other security groups of the same type.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): securitygroup-write ````",
"operationId": "UsersByIdSecurityGroupsPost",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the service rep to associated with the specified group",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "Request containing ID of security group to attach service rep to",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.SetUserSecurityGroupRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.SetUserSecurityGroupRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.SetUserSecurityGroupRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.SetUserSecurityGroupRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.SetUserSecurityGroupRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.SetUserSecurityGroupRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.SetUserSecurityGroupRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.SetUserSecurityGroupRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Users/{id}/securityGroups/{securityGroupTypeId}": {
"delete": {
"tags": [
"Users"
],
"summary": "Remove specified user from security groups of a given type.",
"description": "A user should never be associated with more than one security group of a given type. So instead of requiring the current SecurityGroupId to be passed in, we always just delete all.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): securitygroup-write ````",
"operationId": "UsersByIdSecurityGroupsBySecurityGroupTypeIdDelete",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "securityGroupTypeId",
"in": "path",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Users/{id}/webUser": {
"get": {
"tags": [
"Users"
],
"summary": "Get Service Rep Web User",
"description": "Gets the Web User Account for the Service Rep if the Service Rep has one.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "UsersByIdWebUserGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the service rep",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.GetWebUserAccountDetails.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.GetWebUserAccountDetails.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.GetWebUserAccountDetails.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.GetWebUserAccountDetails.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.GetWebUserAccountDetails.Result"
}
}
}
}
}
}
},
"/Users/bookmarks": {
"get": {
"tags": [
"Users"
],
"summary": "Get User Bookmarks",
"description": "Returns a list of bookmarks for the user\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "UsersBookmarksGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of bookmarks to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of bookmarks to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Users.UserBookmarksQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Users.UserBookmarksQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Users.UserBookmarksQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Users.UserBookmarksQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Users.UserBookmarksQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Users.UserBookmarksQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Users.UserBookmarksQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Users"
],
"summary": "Create User Bookmark",
"description": "Creates a bookmark for the user at the specified route. The Bookmark is added to the bottom of the list (lowest existing sort order + 1)\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "UsersBookmarksPost",
"requestBody": {
"description": "The new bookmark to create",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.CreateBookmarkRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.CreateBookmarkRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.CreateBookmarkRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.CreateBookmarkRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.CreateBookmarkRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.CreateBookmarkRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.CreateBookmarkRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.CreateBookmarkRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.Users.CreateUserBookmarkCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.Users.CreateUserBookmarkCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.Users.CreateUserBookmarkCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.Users.CreateUserBookmarkCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.Users.CreateUserBookmarkCommand.Result"
}
}
}
}
}
}
},
"/Users/bookmarks/{bookmarkId}": {
"put": {
"tags": [
"Users"
],
"summary": "Update bookmark sort order",
"description": "Moves the bookmark to the specified sort order and adjusts the bookmarks in between as well\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "UsersBookmarksByBookmarkIdPut",
"parameters": [
{
"name": "bookmarkId",
"in": "path",
"description": "The Id of the bookmark to move",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The new sort order",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.UpdateBookmarkSortOrderRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.UpdateBookmarkSortOrderRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.UpdateBookmarkSortOrderRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.UpdateBookmarkSortOrderRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.UpdateBookmarkSortOrderRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.UpdateBookmarkSortOrderRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.UpdateBookmarkSortOrderRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.UpdateBookmarkSortOrderRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
},
"delete": {
"tags": [
"Users"
],
"summary": "Delete Bookmark",
"description": "Deletes the specified bookmark.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "UsersBookmarksByBookmarkIdDelete",
"parameters": [
{
"name": "bookmarkId",
"in": "path",
"description": "The Id of the bookmark to move",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Users/cache": {
"delete": {
"tags": [
"Users"
],
"summary": "Remove cache for user",
"description": "Removes all cached objects for the user\n \n```` Allows roles: ServiceRep, Service, WebUserEmployee, WebUserContact, WebUserServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "UsersCacheDelete",
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Users/configurations/cached": {
"delete": {
"tags": [
"Users"
],
"summary": "Remove cached configurations",
"description": "Removes all cached configurations from the api for the current user. Call this to request a refresh of the configurations for a user.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): configuration-read ````",
"operationId": "UsersConfigurationsCachedDelete",
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Users/emailAccounts": {
"get": {
"tags": [
"Users"
],
"summary": "Get User Email Accounts",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "UsersEmailAccountsGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.EmailAccounts.EmailAccountsList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.EmailAccounts.EmailAccountsList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.EmailAccounts.EmailAccountsList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.EmailAccounts.EmailAccountsList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.EmailAccounts.EmailAccountsList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.EmailAccounts.EmailAccountsList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.EmailAccounts.EmailAccountsList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Users"
],
"summary": "Create User Email Account",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "UsersEmailAccountsPost",
"requestBody": {
"description": "The details of the User Email Account to be created.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.CreateEmailAccountRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.CreateEmailAccountRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.CreateEmailAccountRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.CreateEmailAccountRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.CreateEmailAccountRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.CreateEmailAccountRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.CreateEmailAccountRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.CreateEmailAccountRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.EmailAccounts.CreateEmailAccount.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.EmailAccounts.CreateEmailAccount.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.EmailAccounts.CreateEmailAccount.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.EmailAccounts.CreateEmailAccount.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.EmailAccounts.CreateEmailAccount.Result"
}
}
}
}
}
}
},
"/Users/emailAccounts/{accountId}": {
"get": {
"tags": [
"Users"
],
"summary": "Get User Email Account Details",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "UsersEmailAccountsByAccountIdGet",
"parameters": [
{
"name": "accountId",
"in": "path",
"description": "The id of the Email Account.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "refreshOAuthTokenIfNeeded",
"in": "query",
"description": "If true, refresh the email provider's OAuth token if it expires soon.",
"style": "form",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.EmailAccounts.EmailAccountDetailsResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.EmailAccounts.EmailAccountDetailsResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.EmailAccounts.EmailAccountDetailsResult"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.EmailAccounts.EmailAccountDetailsResult"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.EmailAccounts.EmailAccountDetailsResult"
}
}
}
}
}
},
"put": {
"tags": [
"Users"
],
"summary": "Update User Email Account",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "UsersEmailAccountsByAccountIdPut",
"parameters": [
{
"name": "accountId",
"in": "path",
"description": "The Account Id of the Email Account.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The details of the Email Account to update.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.UpdateEmailAccountRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.UpdateEmailAccountRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.UpdateEmailAccountRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.UpdateEmailAccountRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.UpdateEmailAccountRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.UpdateEmailAccountRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.UpdateEmailAccountRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.UpdateEmailAccountRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
},
"delete": {
"tags": [
"Users"
],
"summary": "Delete User Email Account",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "UsersEmailAccountsByAccountIdDelete",
"parameters": [
{
"name": "accountId",
"in": "path",
"description": "The Id of the User Email Account to delete.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Users/emailAccounts/{accountId}/diag": {
"get": {
"tags": [
"Users"
],
"summary": "Get Diagnostic Information for existing user email accounts.",
"description": "Returns detailed diagnostic info for an existing user email account using the current configured credentials.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "UsersEmailAccountsByAccountIdDiagGet",
"parameters": [
{
"name": "accountId",
"in": "path",
"description": "The id of the email account.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.EmailAccounts.TestEmailAccount.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.EmailAccounts.TestEmailAccount.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.EmailAccounts.TestEmailAccount.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.EmailAccounts.TestEmailAccount.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.EmailAccounts.TestEmailAccount.Result"
}
}
}
}
}
}
},
"/Users/emailAccounts/{accountId}/redeemOauthCode": {
"post": {
"tags": [
"Users"
],
"summary": "Redeem an authorization code for an access token for a protected resource, such as Microsoft 365.",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): email-write ````",
"operationId": "UsersEmailAccountsByAccountIdRedeemOauthCodePost",
"parameters": [
{
"name": "accountId",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.RedeemOauthCodeForExistingEmailAccountRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.RedeemOauthCodeForExistingEmailAccountRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.RedeemOauthCodeForExistingEmailAccountRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.RedeemOauthCodeForExistingEmailAccountRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.RedeemOauthCodeForExistingEmailAccountRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.RedeemOauthCodeForExistingEmailAccountRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.RedeemOauthCodeForExistingEmailAccountRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.RedeemOauthCodeForExistingEmailAccountRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Users/emailAccounts/redeemOauthCode": {
"post": {
"tags": [
"Users"
],
"summary": "Redeem an authorization code for an access token for a protected resource, such as Microsoft 365.\r\nA new TempWorks email account is then created with those new OAuth credentials.\r\nDefault values are used for required fields on the email account.\r\nThe Id of the new Email Account is returned.",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): email-write ````",
"operationId": "UsersEmailAccountsRedeemOauthCodePost",
"requestBody": {
"description": "",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.RedeemOauthCodeForNewEmailAccountRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.RedeemOauthCodeForNewEmailAccountRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.RedeemOauthCodeForNewEmailAccountRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.RedeemOauthCodeForNewEmailAccountRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.RedeemOauthCodeForNewEmailAccountRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.RedeemOauthCodeForNewEmailAccountRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.RedeemOauthCodeForNewEmailAccountRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.RedeemOauthCodeForNewEmailAccountRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.EmailAccounts.RedeemOAuthCodeForNewEmailAccount.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.EmailAccounts.RedeemOAuthCodeForNewEmailAccount.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.EmailAccounts.RedeemOAuthCodeForNewEmailAccount.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.EmailAccounts.RedeemOAuthCodeForNewEmailAccount.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.EmailAccounts.RedeemOAuthCodeForNewEmailAccount.Result"
}
}
}
}
}
}
},
"/Users/emailAccounts/signatures": {
"get": {
"tags": [
"Users"
],
"summary": "Get User Email Signatures",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "UsersEmailAccountsSignaturesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.EmailAccounts.EmailSignaturesList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.EmailAccounts.EmailSignaturesList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.EmailAccounts.EmailSignaturesList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.EmailAccounts.EmailSignaturesList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.EmailAccounts.EmailSignaturesList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.EmailAccounts.EmailSignaturesList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.EmailAccounts.EmailSignaturesList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"post": {
"tags": [
"Users"
],
"summary": "Create User Email Signature",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "UsersEmailAccountsSignaturesPost",
"requestBody": {
"description": "The details of the User Email Signature to be created.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.UpsertEmailSignatureRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.UpsertEmailSignatureRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.UpsertEmailSignatureRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.UpsertEmailSignatureRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.UpsertEmailSignatureRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.UpsertEmailSignatureRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.UpsertEmailSignatureRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.UpsertEmailSignatureRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.EmailAccounts.CreateEmailSignature.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.EmailAccounts.CreateEmailSignature.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.EmailAccounts.CreateEmailSignature.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.EmailAccounts.CreateEmailSignature.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.EmailAccounts.CreateEmailSignature.Result"
}
}
}
}
}
}
},
"/Users/emailAccounts/signatures/{signatureGuid}": {
"get": {
"tags": [
"Users"
],
"summary": "Get User Email Signature",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "UsersEmailAccountsSignaturesBySignatureGuidGet",
"parameters": [
{
"name": "signatureGuid",
"in": "path",
"description": "The Guid of the Email Signature.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.EmailAccounts.EmailSignatureDetails.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.EmailAccounts.EmailSignatureDetails.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.EmailAccounts.EmailSignatureDetails.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.EmailAccounts.EmailSignatureDetails.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.EmailAccounts.EmailSignatureDetails.Result"
}
}
}
}
}
},
"put": {
"tags": [
"Users"
],
"summary": "Update User Email Signature",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "UsersEmailAccountsSignaturesBySignatureGuidPut",
"parameters": [
{
"name": "signatureGuid",
"in": "path",
"description": "The Signature Guid of the Email Signature.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The details of the Email Signature to update.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.UpsertEmailSignatureRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.UpsertEmailSignatureRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.UpsertEmailSignatureRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.UpsertEmailSignatureRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.UpsertEmailSignatureRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.UpsertEmailSignatureRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.UpsertEmailSignatureRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.UpsertEmailSignatureRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
},
"delete": {
"tags": [
"Users"
],
"summary": "Delete User Email Signature",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "UsersEmailAccountsSignaturesBySignatureGuidDelete",
"parameters": [
{
"name": "signatureGuid",
"in": "path",
"description": "The Guid of the User Email Signature to delete.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Users/emailAccounts/signatures/{signatureId}": {
"get": {
"tags": [
"Users"
],
"summary": "Get User Email Signature",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "UsersEmailAccountsSignaturesBySignatureIdGet",
"parameters": [
{
"name": "signatureId",
"in": "path",
"description": "The id of the Email Signature.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.EmailAccounts.EmailSignatureDetails.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.EmailAccounts.EmailSignatureDetails.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.EmailAccounts.EmailSignatureDetails.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.EmailAccounts.EmailSignatureDetails.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.EmailAccounts.EmailSignatureDetails.Result"
}
}
}
}
}
},
"put": {
"tags": [
"Users"
],
"summary": "Update User Email Signature",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "UsersEmailAccountsSignaturesBySignatureIdPut",
"parameters": [
{
"name": "signatureId",
"in": "path",
"description": "The Signature Id of the Email Signature.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The details of the Email Signature to update.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.UpsertEmailSignatureRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.UpsertEmailSignatureRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.UpsertEmailSignatureRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.UpsertEmailSignatureRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.UpsertEmailSignatureRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.UpsertEmailSignatureRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.UpsertEmailSignatureRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.UpsertEmailSignatureRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
},
"delete": {
"tags": [
"Users"
],
"summary": "Delete User Email Signature",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "UsersEmailAccountsSignaturesBySignatureIdDelete",
"parameters": [
{
"name": "signatureId",
"in": "path",
"description": "The Id of the User Email Signature to delete.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Users/externalServices/{externalServiceId}": {
"get": {
"tags": [
"Users"
],
"summary": "Get External Service Credentials for User",
"description": "Gets the credentials best matched to the user's current hierarchy based off of the credentials stored in the system.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "UsersExternalServicesByExternalServiceIdGet",
"parameters": [
{
"name": "externalServiceId",
"in": "path",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "returnNullOnMissingCredentials",
"in": "query",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.ExternalService.CredentialsDetails.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.ExternalService.CredentialsDetails.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.ExternalService.CredentialsDetails.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.ExternalService.CredentialsDetails.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.ExternalService.CredentialsDetails.Result"
}
}
}
}
}
}
},
"/Users/externalServices/metadata": {
"get": {
"tags": [
"Users"
],
"summary": "Get External Service Metadata for User",
"description": "Returns information about which services are enabled in the system and whether or not they have credentials set up accessible to the current user.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "UsersExternalServicesMetadataGet",
"parameters": [
{
"name": "externalServiceId",
"in": "path",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "returnNullOnMissingCredentials",
"in": "query",
"style": "form",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.ExternalServices.ExternalServicesMetadata.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.ExternalServices.ExternalServicesMetadata.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.ExternalServices.ExternalServicesMetadata.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.ExternalServices.ExternalServicesMetadata.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.ExternalServices.ExternalServicesMetadata.Result"
}
}
}
}
}
}
},
"/Users/features": {
"get": {
"tags": [
"Users"
],
"summary": "Get User Features",
"description": "Returns the features available for the current user.\n \n```` Allows roles: ServiceRep, WebUserEmployee, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "UsersFeaturesGet",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Users.UserCachedFlattenedFeatures.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Users.UserCachedFlattenedFeatures.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Users.UserCachedFlattenedFeatures.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Users.UserCachedFlattenedFeatures.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Users.UserCachedFlattenedFeatures.Result"
}
}
}
}
}
}
},
"/Users/hierarchy": {
"get": {
"tags": [
"Users"
],
"summary": "Get User Allowed Hierarchy Tree",
"description": "Returns a tree of the hierarchy a user is allowed to move within.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "UsersHierarchyGet",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.Users.UserSelectableHierarchyQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.Users.UserSelectableHierarchyQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.Users.UserSelectableHierarchyQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.Users.UserSelectableHierarchyQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.Users.UserSelectableHierarchyQuery.Result"
}
}
}
}
}
},
"put": {
"tags": [
"Users"
],
"summary": "Update User Hierarchy",
"description": "Updates where the user is in the hierarchy.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "UsersHierarchyPut",
"requestBody": {
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.UpdateUserHierarchyRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.UpdateUserHierarchyRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.UpdateUserHierarchyRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.UpdateUserHierarchyRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.UpdateUserHierarchyRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.UpdateUserHierarchyRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.UpdateUserHierarchyRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.UpdateUserHierarchyRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Users/hierarchy/{ServiceRepId}": {
"get": {
"tags": [
"Users"
],
"summary": "Get the provided ServiceRepId visible hierarchy",
"description": "Returns a list of the hierarchy a user is allowed to utilize.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "UsersHierarchyByServiceRepIdGet",
"parameters": [
{
"name": "ServiceRepId",
"in": "path",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/Users/hierarchyTypes": {
"get": {
"tags": [
"Users"
],
"summary": "Get User Allowed Hierarchy Types",
"description": "Returns a list of the hierarchy types a user is allowed to use.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "UsersHierarchyTypesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of hierarchy types to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of hierarchy types to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Users.UserSelectableHierTypeQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Users.UserSelectableHierTypeQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Users.UserSelectableHierTypeQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Users.UserSelectableHierTypeQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Users.UserSelectableHierTypeQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Users.UserSelectableHierTypeQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Users.UserSelectableHierTypeQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Users/License": {
"get": {
"tags": [
"Users"
],
"summary": "Get The License Details",
"description": "Gets the license details.\n \n```` Allows roles: ServiceRep, WebUserEmployee, Service ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "UsersLicenseGet",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Users.UserLicense.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Users.UserLicense.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Users.UserLicense.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Users.UserLicense.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Users.UserLicense.Result"
}
}
}
}
}
}
},
"/Users/localization": {
"get": {
"tags": [
"Users"
],
"summary": "Get User Localization settings",
"description": "Returns the localization settings for the specified user. Settings include such items as date and time formats as well as language and time zone\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "UsersLocalizationGet",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Users.UserLocalizationSettingsQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Users.UserLocalizationSettingsQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Users.UserLocalizationSettingsQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Users.UserLocalizationSettingsQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Users.UserLocalizationSettingsQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Users.UserLocalizationSettingsQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Users.UserLocalizationSettingsQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
},
"put": {
"tags": [
"Users"
],
"summary": "Update User Localization Settings",
"description": "Updates the authenticated user's localization settings to the specified values.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "UsersLocalizationPut",
"requestBody": {
"description": "The updated values for user localization.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.UpdateUserLocalizationSettingsRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.UpdateUserLocalizationSettingsRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.UpdateUserLocalizationSettingsRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.UpdateUserLocalizationSettingsRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.UpdateUserLocalizationSettingsRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.UpdateUserLocalizationSettingsRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.UpdateUserLocalizationSettingsRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.UpdateUserLocalizationSettingsRequest"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Users/localization/labelOverrides": {
"get": {
"tags": [
"Users"
],
"summary": "Get User Localization Labels",
"description": "Returns a list of Localized Label Overrides for the locale specified on the User's Service Rep record.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "UsersLocalizationLabelOverridesGet",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"text/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"application/xml": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"text/xml": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
}
}
}
}
},
"/Users/permissions": {
"get": {
"tags": [
"Users"
],
"summary": "Get User Permissions List",
"description": "Returns the list of permissions for the current user which has been granted via their security group. The list is ordered by the permission Id\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "UsersPermissionsGet",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Users.UserCachedPermissionsQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Users.UserCachedPermissionsQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Users.UserCachedPermissionsQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Users.UserCachedPermissionsQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Users.UserCachedPermissionsQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Users.UserCachedPermissionsQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Users.UserCachedPermissionsQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Users/permissions/cached": {
"delete": {
"tags": [
"Users"
],
"summary": "Delete Cached User Permissions",
"description": "Removes the cached permission entries for the current user.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "UsersPermissionsCachedDelete",
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Users/ServiceRepTokens": {
"get": {
"tags": [
"Users"
],
"summary": "Get Service Rep Tokens",
"description": "Gets a list of tokens created by the user.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "UsersServiceRepTokensGet",
"parameters": [
{
"name": "description",
"in": "query",
"description": "Used to filter the results for either active or inactive tokens.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "isActive",
"in": "query",
"description": "Used to filter the results for either active or inactive tokens. Provide null to get both active and inactive\r\ntokens back.",
"style": "form",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.GetServiceRepTokenQuery.Response"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.GetServiceRepTokenQuery.Response"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.GetServiceRepTokenQuery.Response"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.GetServiceRepTokenQuery.Response"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.GetServiceRepTokenQuery.Response"
}
}
}
}
}
},
"post": {
"tags": [
"Users"
],
"summary": "Create a Service Rep Token",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): Reserved For TempWorks' Products Only ````",
"operationId": "UsersServiceRepTokensPost",
"requestBody": {
"description": "Request containing a description of the token, the allowed scopes and the expiration date",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.CreateCurrentUserServiceRepTokenRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.CreateCurrentUserServiceRepTokenRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.CreateCurrentUserServiceRepTokenRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.CreateCurrentUserServiceRepTokenRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.CreateCurrentUserServiceRepTokenRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.CreateCurrentUserServiceRepTokenRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.CreateCurrentUserServiceRepTokenRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.CreateCurrentUserServiceRepTokenRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.System.CreateServiceRepTokenData.Response"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.System.CreateServiceRepTokenData.Response"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.System.CreateServiceRepTokenData.Response"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.System.CreateServiceRepTokenData.Response"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.System.CreateServiceRepTokenData.Response"
}
}
}
}
}
}
},
"/Users/settings": {
"delete": {
"tags": [
"Users"
],
"summary": "Delete All User Settings",
"description": "Deletes all user settings.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "UsersSettingsDelete",
"responses": {
"204": {
"description": "Settings deleted successfully"
}
}
}
},
"/Users/settings/{objectName}": {
"get": {
"tags": [
"Users"
],
"summary": "Get User Settings",
"description": "Returns the specified settings for the specified user.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "UsersSettingsByObjectNameGet",
"parameters": [
{
"name": "objectName",
"in": "path",
"description": "The name of the specified setting. The name is case insensitive.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"204": {
"description": "No Content, if specified settings are null, whitespace or cannot be found."
}
}
},
"post": {
"tags": [
"Users"
],
"summary": "Create/Update User Settings",
"description": "Creates or Updated the specified user settings.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "UsersSettingsByObjectNamePost",
"parameters": [
{
"name": "objectName",
"in": "path",
"description": "The name of the specified setting. All alpha characters on object name will be converted to lower case letters.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The content to store. The entire body of the request will be stored. Any value or object is valid except for whitespace.",
"content": {
"application/vnd.textus+jsonld": {
"schema": { },
"example": [{"value":"SampleNote","path":"/PayrollNote","op":"replace"},{"value":50.0,"path":"/OneTimeOverrideRegionWithholding","op":"add"},{"path":"/OneTimeOverrideRegionWithholding","op":"remove"},{"path":"/PayrollNote","op":"copy","from":"/DateWorked"},{"path":"/PayrollNote","op":"move","from":"/DateWorked"},{"value":"SampleNote","path":"/PayrollNote","op":"test"}]
},
"application/json-patch+json": {
"schema": { },
"example": [{"value":"SampleNote","path":"/PayrollNote","op":"replace"},{"value":50.0,"path":"/OneTimeOverrideRegionWithholding","op":"add"},{"path":"/OneTimeOverrideRegionWithholding","op":"remove"},{"path":"/PayrollNote","op":"copy","from":"/DateWorked"},{"path":"/PayrollNote","op":"move","from":"/DateWorked"},{"value":"SampleNote","path":"/PayrollNote","op":"test"}]
},
"application/json": {
"schema": { },
"example": [{"value":"SampleNote","path":"/PayrollNote","op":"replace"},{"value":50.0,"path":"/OneTimeOverrideRegionWithholding","op":"add"},{"path":"/OneTimeOverrideRegionWithholding","op":"remove"},{"path":"/PayrollNote","op":"copy","from":"/DateWorked"},{"path":"/PayrollNote","op":"move","from":"/DateWorked"},{"value":"SampleNote","path":"/PayrollNote","op":"test"}]
},
"text/json": {
"schema": { },
"example": [{"value":"SampleNote","path":"/PayrollNote","op":"replace"},{"value":50.0,"path":"/OneTimeOverrideRegionWithholding","op":"add"},{"path":"/OneTimeOverrideRegionWithholding","op":"remove"},{"path":"/PayrollNote","op":"copy","from":"/DateWorked"},{"path":"/PayrollNote","op":"move","from":"/DateWorked"},{"value":"SampleNote","path":"/PayrollNote","op":"test"}]
},
"application/*+json": {
"schema": { },
"example": [{"value":"SampleNote","path":"/PayrollNote","op":"replace"},{"value":50.0,"path":"/OneTimeOverrideRegionWithholding","op":"add"},{"path":"/OneTimeOverrideRegionWithholding","op":"remove"},{"path":"/PayrollNote","op":"copy","from":"/DateWorked"},{"path":"/PayrollNote","op":"move","from":"/DateWorked"},{"value":"SampleNote","path":"/PayrollNote","op":"test"}]
},
"application/xml": {
"schema": { },
"example": "\r\n \r\n \r\n replace\r\n /PayrollNote\r\n SampleNote\r\n \r\n \r\n \r\n add\r\n /OneTimeOverrideRegionWithholding\r\n 50\r\n \r\n \r\n \r\n remove\r\n /OneTimeOverrideRegionWithholding\r\n \r\n \r\n \r\n /DateWorked\r\n copy\r\n /PayrollNote\r\n \r\n \r\n \r\n /DateWorked\r\n move\r\n /PayrollNote\r\n \r\n \r\n \r\n \r\n test\r\n /PayrollNote\r\n SampleNote\r\n \r\n"
},
"text/xml": {
"schema": { },
"example": "\r\n \r\n \r\n replace\r\n /PayrollNote\r\n SampleNote\r\n \r\n \r\n \r\n add\r\n /OneTimeOverrideRegionWithholding\r\n 50\r\n \r\n \r\n \r\n remove\r\n /OneTimeOverrideRegionWithholding\r\n \r\n \r\n \r\n /DateWorked\r\n copy\r\n /PayrollNote\r\n \r\n \r\n \r\n /DateWorked\r\n move\r\n /PayrollNote\r\n \r\n \r\n \r\n \r\n test\r\n /PayrollNote\r\n SampleNote\r\n \r\n"
},
"application/*+xml": {
"schema": { },
"example": "\r\n \r\n \r\n replace\r\n /PayrollNote\r\n SampleNote\r\n \r\n \r\n \r\n add\r\n /OneTimeOverrideRegionWithholding\r\n 50\r\n \r\n \r\n \r\n remove\r\n /OneTimeOverrideRegionWithholding\r\n \r\n \r\n \r\n /DateWorked\r\n copy\r\n /PayrollNote\r\n \r\n \r\n \r\n /DateWorked\r\n move\r\n /PayrollNote\r\n \r\n \r\n \r\n \r\n test\r\n /PayrollNote\r\n SampleNote\r\n \r\n"
}
}
},
"responses": {
"204": {
"description": "Settings have been saved successfully"
}
}
},
"delete": {
"tags": [
"Users"
],
"summary": "Delete User Setting",
"description": "Deletes the specified user setting.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "UsersSettingsByObjectNameDelete",
"parameters": [
{
"name": "objectName",
"in": "path",
"description": "The name of the specified setting. The object name is case insensitive.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Setting deleted successfully"
}
}
}
},
"/Users/Tokens": {
"get": {
"tags": [
"Users"
],
"summary": "Get Service Rep Tokens",
"description": "Gets a list of tokens created by the user.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "UsersTokensGet",
"parameters": [
{
"name": "description",
"in": "query",
"description": "Used to filter the results for either active or inactive tokens.",
"style": "form",
"schema": {
"type": "string"
}
},
{
"name": "isActive",
"in": "query",
"description": "Used to filter the results for either active or inactive tokens. Provide null to get both active and inactive\r\ntokens back.",
"style": "form",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.GetServiceRepTokenQuery.Response"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.GetServiceRepTokenQuery.Response"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.GetServiceRepTokenQuery.Response"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.GetServiceRepTokenQuery.Response"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.GetServiceRepTokenQuery.Response"
}
}
}
}
}
},
"post": {
"tags": [
"Users"
],
"summary": "Create a Service Rep Token",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): Reserved For TempWorks' Products Only ````",
"operationId": "UsersTokensPost",
"requestBody": {
"description": "Request containing a description of the token, the allowed scopes and the expiration date",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.CreateCurrentUserServiceRepTokenRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.CreateCurrentUserServiceRepTokenRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.CreateCurrentUserServiceRepTokenRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.CreateCurrentUserServiceRepTokenRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.CreateCurrentUserServiceRepTokenRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.CreateCurrentUserServiceRepTokenRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.CreateCurrentUserServiceRepTokenRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.Users.RequestModels.CreateCurrentUserServiceRepTokenRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.System.CreateServiceRepTokenData.Response"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.System.CreateServiceRepTokenData.Response"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.System.CreateServiceRepTokenData.Response"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.System.CreateServiceRepTokenData.Response"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Messages.System.CreateServiceRepTokenData.Response"
}
}
}
}
}
}
},
"/utilities/calculateRatesUsingMultiplierCode": {
"post": {
"tags": [
"Utilities"
],
"summary": "Calculates Rates Using Multiplier Code",
"description": "Calculates pay and bill rates based on the multiplier code provided and the field that changed.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "UtilitiesCalculateRatesUsingMultiplierCodePost",
"requestBody": {
"description": "The request body containing the multiplier code to use, what field changed, and existing values.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.CalculateMarkupsUsingMultiplierCodeRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.CalculateMarkupsUsingMultiplierCodeRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.CalculateMarkupsUsingMultiplierCodeRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.CalculateMarkupsUsingMultiplierCodeRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.CalculateMarkupsUsingMultiplierCodeRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.CalculateMarkupsUsingMultiplierCodeRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.CalculateMarkupsUsingMultiplierCodeRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.CalculateMarkupsUsingMultiplierCodeRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Utilities.CalculateMarkupsCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Utilities.CalculateMarkupsCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Utilities.CalculateMarkupsCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Utilities.CalculateMarkupsCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Utilities.CalculateMarkupsCommand.Result"
}
}
}
}
}
}
},
"/utilities/dataExport/categories": {
"get": {
"tags": [
"Utilities"
],
"summary": "Data Export Categories List",
"description": "Gets a list of categories that can be used to help filter on the list of data exports.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): report-read ````",
"operationId": "UtilitiesDataExportCategoriesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.DataExport.DataExportCategoryList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.DataExport.DataExportCategoryList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.DataExport.DataExportCategoryList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.DataExport.DataExportCategoryList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.DataExport.DataExportCategoryList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.DataExport.DataExportCategoryList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.DataExport.DataExportCategoryList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/utilities/dataExport/exports": {
"get": {
"tags": [
"Utilities"
],
"summary": "Data Exports List",
"description": "Gets a list of exports that can be used to extract information from the system.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): report-read ````",
"operationId": "UtilitiesDataExportExportsGet",
"parameters": [
{
"name": "exportCategoryId",
"in": "query",
"description": "An optional filter on the export category. A list of valid values can be found at the Data Export Categories List endpoint.",
"style": "form",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.DataExport.DataExportList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.DataExport.DataExportList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.DataExport.DataExportList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.DataExport.DataExportList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.DataExport.DataExportList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.DataExport.DataExportList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.DataExport.DataExportList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/utilities/dataExport/exports/{exportId}": {
"get": {
"tags": [
"Utilities"
],
"summary": "Data Export",
"description": "Gets an individual export that can be used to extract information from the system.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): report-read ````",
"operationId": "UtilitiesDataExportExportsByExportIdGet",
"parameters": [
{
"name": "exportId",
"in": "path",
"description": "The Id of the export.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.DataExport.DataExportList.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.DataExport.DataExportList.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.DataExport.DataExportList.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.DataExport.DataExportList.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.DataExport.DataExportList.Result"
}
}
}
}
}
},
"post": {
"tags": [
"Utilities"
],
"summary": "Run Data Export",
"description": "Gets a list of parameters and their potential values for an export. Review the Supported Media Types part of the developer documentation to\r\ndetermine how to change the media type of the response.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): report-read ````",
"operationId": "UtilitiesDataExportExportsByExportIdPost",
"parameters": [
{
"name": "exportId",
"in": "path",
"description": "The Id of the export.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "The request body containing the parameters to pass into the export.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.RunDataExportRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.RunDataExportRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.RunDataExportRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.RunDataExportRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.RunDataExportRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.RunDataExportRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.RunDataExportRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.RunDataExportRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": { }
}
},
"text/csv": {
"schema": {
"type": "array",
"items": { }
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"type": "array",
"items": { }
}
},
"application/json": {
"schema": {
"type": "array",
"items": { }
}
},
"text/json": {
"schema": {
"type": "array",
"items": { }
}
},
"application/xml": {
"schema": {
"type": "array",
"items": { }
}
},
"text/xml": {
"schema": {
"type": "array",
"items": { }
}
}
}
}
}
}
},
"/utilities/dataExport/exports/{exportId}/parameters": {
"get": {
"tags": [
"Utilities"
],
"summary": "Data Export Parameters",
"description": "Gets a list of parameters and their potential values for an export.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): report-read ````",
"operationId": "UtilitiesDataExportExportsByExportIdParametersGet",
"parameters": [
{
"name": "exportId",
"in": "path",
"description": "The Id of the export.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.DataExport.DataExportParameterList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.DataExport.DataExportParameterList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.DataExport.DataExportParameterList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.DataExport.DataExportParameterList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.DataExport.DataExportParameterList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.DataExport.DataExportParameterList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.DataExport.DataExportParameterList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/utilities/ParseResume": {
"post": {
"tags": [
"Utilities"
],
"summary": "Returns the HR-XML compliant representation of the posted resume file.",
"description": "This is a premium feature requiring 'resumeparser' scope.\n \n```` Allows roles: ServiceRep, Service ````\n \n```` Requires scope(s): resumeparser ````",
"operationId": "UtilitiesParseResumePost",
"responses": {
"200": {
"description": "HR-XML representation of the resume"
}
}
}
},
"/utilities/standardizeAddresses": {
"post": {
"tags": [
"Utilities"
],
"summary": "Standardize a list of addresses",
"description": "\n \n```` Allows roles: Service, ServiceRep, WebUserEmployee, WebUserContact ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "UtilitiesStandardizeAddressesPost",
"requestBody": {
"description": "The request body containing the list of addresses to be standardized and the country in which the addresses reside.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.StandardizeAddressesRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.StandardizeAddressesRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.StandardizeAddressesRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.StandardizeAddressesRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.StandardizeAddressesRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.StandardizeAddressesRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.StandardizeAddressesRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.StandardizeAddressesRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TempWorks.TwApi.Common.Models.StandardizedAddress"
}
}
},
"text/csv": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TempWorks.TwApi.Common.Models.StandardizedAddress"
}
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TempWorks.TwApi.Common.Models.StandardizedAddress"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TempWorks.TwApi.Common.Models.StandardizedAddress"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TempWorks.TwApi.Common.Models.StandardizedAddress"
}
}
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TempWorks.TwApi.Common.Models.StandardizedAddress"
}
}
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TempWorks.TwApi.Common.Models.StandardizedAddress"
}
}
}
}
}
}
}
},
"/utilities/wordListGenerator": {
"get": {
"tags": [
"Utilities"
],
"summary": "Generate Word List",
"description": "Generates a list of words from the most common English words.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): No Scope Required ````",
"operationId": "UtilitiesWordListGeneratorGet",
"parameters": [
{
"name": "numberOfWords",
"in": "query",
"description": "The number of words to return.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "minimumWordLength",
"in": "query",
"description": "The minimum length of characters in the words to return.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "maximumWordLength",
"in": "query",
"description": "The maximum length of characters in the words to return.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 2147483647
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"text/csv": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
}
},
"/Vendors": {
"post": {
"tags": [
"Vendors"
],
"summary": "Create Vendor",
"description": "Creates a vendor with the specified values.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): vendor-write ````",
"operationId": "VendorsPost",
"requestBody": {
"description": "A model containing the information with which to create the new vendor.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Vendors.API.Models.CreateCompanyRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Vendors.API.Models.CreateCompanyRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Vendors.API.Models.CreateCompanyRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Vendors.API.Models.CreateCompanyRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Vendors.API.Models.CreateCompanyRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Vendors.API.Models.CreateCompanyRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Vendors.API.Models.CreateCompanyRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Vendors.API.Models.CreateCompanyRequest"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Vendors.Service.Commands.CreateCompanyCommand.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Vendors.Service.Commands.CreateCompanyCommand.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Vendors.Service.Commands.CreateCompanyCommand.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Vendors.Service.Commands.CreateCompanyCommand.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Vendors.Service.Commands.CreateCompanyCommand.Result"
}
}
}
}
}
}
},
"/Vendors/{id}": {
"get": {
"tags": [
"Vendors"
],
"summary": "Get Vendor Details",
"description": "Gets details about the specified vendor.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): vendor-read ````",
"operationId": "VendorsByIdGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the vendor",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Vendors.Service.Commands.CompanyDetailsQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Vendors.Service.Commands.CompanyDetailsQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Vendors.Service.Commands.CompanyDetailsQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Vendors.Service.Commands.CompanyDetailsQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Vendors.Service.Commands.CompanyDetailsQuery.Result"
}
}
}
}
}
},
"patch": {
"tags": [
"Vendors"
],
"summary": "Patch Vendor",
"description": "\r\n\r\n Allows for Json patching to be performed against vendor fields.\r\n More information about PATCHING, see https://developer.ontempworks.com/docs/your-request\r\n \r\n\r\n\r\n Valid Patch paths: /AccountId (int?), /ActivationDate (DateTime?), /IsActive (bool), /BusinessCodeId (Guid?), /CertificateOnFile (bool), /CompanyAddress (string), /AltCompanyId (string), /PhoneNumberCountryCallingCode (int), /PhoneNumber (string), /CompanyTypeId (Guid), /ContactName (string), /ContractEndDate (DateTime?), /ContractStartDate (DateTime?), /CorporateStreet1 (string), /CorporateStreet2 (string), /CorporateMunicipality (string), /CorporateRegion (string), /CorporatePostalCode (string), /CorporateCountry (string), /CorporateCountryCode (int), /CreditLimit (decimal?), /IsDefaultCompany (bool), /DepartmentName (string), /DiscountMethod (string), /EmployerId (int), /EmailAddress (string), /FedEmployerId (string), /CompanyName (string), /ShouldGenerate1099 (bool), /HierId (int), /IsInvoicePayRequired (bool), /IsPayrollDedVendor (bool), /IsPayrollSalesTaxVendor (bool), /IsPayrollTaxVendor (bool), /IsVendor (bool), /LocalStreet1 (string), /LocalStreet2 (string), /LocalMunicipality (string), /LocalRegion (string), /LocalPostalCode (string), /LocalCountry (string), /LocalCountryCode (int), /IsMinorityOwned (bool), /Note (string), /OverheadMarkup (decimal), /ParentCompanyIdent (int?), /PayBeginningDate (DateTime?), /PayDelayInDays (int), /PaymentsIncludeVAT (bool), /PaymentTermsCodeId (int?), /PaymentTypeId (int), /PseudoEmployeeId (long?), /RemittanceStreet1 (string), /RemittanceStreet2 (string), /RemittanceMunicipality (string), /RemittanceRegion (string), /RemittancePostalCode (string), /RemittanceCountry (string), /RemittanceCountryCode (int), /RootCompanyIdent (int?), /IsSBARegistered (bool), /IsSmallBusiness (bool), /Status (string), /SuppliesDisabledPeople (bool), /VendorAccountNumber (string), /IsWomenOwned (bool), /BypassAddressValidationService (bool?)\r\n \n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): vendor-write ````",
"operationId": "VendorsByIdPatch",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the vendor",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "A Json array of patch operations to be performed.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":"3140 Neil Armstrong Blvd","path":"/CorporateStreet1","op":"replace"},{"value":"SampleCompanyName","path":"/EmailAddress","op":"add"},{"path":"/PhoneNumber","op":"remove"},{"path":"/CorporateStreet1","op":"copy","from":"/LocalStreet1"},{"path":"/CorporateStreet1","op":"move","from":"/LocalStreet1"},{"value":"3140 Neil Armstrong Blvd","path":"/CorporateStreet1","op":"test"}]
},
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":"3140 Neil Armstrong Blvd","path":"/CorporateStreet1","op":"replace"},{"value":"SampleCompanyName","path":"/EmailAddress","op":"add"},{"path":"/PhoneNumber","op":"remove"},{"path":"/CorporateStreet1","op":"copy","from":"/LocalStreet1"},{"path":"/CorporateStreet1","op":"move","from":"/LocalStreet1"},{"value":"3140 Neil Armstrong Blvd","path":"/CorporateStreet1","op":"test"}]
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":"3140 Neil Armstrong Blvd","path":"/CorporateStreet1","op":"replace"},{"value":"SampleCompanyName","path":"/EmailAddress","op":"add"},{"path":"/PhoneNumber","op":"remove"},{"path":"/CorporateStreet1","op":"copy","from":"/LocalStreet1"},{"path":"/CorporateStreet1","op":"move","from":"/LocalStreet1"},{"value":"3140 Neil Armstrong Blvd","path":"/CorporateStreet1","op":"test"}]
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":"3140 Neil Armstrong Blvd","path":"/CorporateStreet1","op":"replace"},{"value":"SampleCompanyName","path":"/EmailAddress","op":"add"},{"path":"/PhoneNumber","op":"remove"},{"path":"/CorporateStreet1","op":"copy","from":"/LocalStreet1"},{"path":"/CorporateStreet1","op":"move","from":"/LocalStreet1"},{"value":"3140 Neil Armstrong Blvd","path":"/CorporateStreet1","op":"test"}]
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": [{"value":"3140 Neil Armstrong Blvd","path":"/CorporateStreet1","op":"replace"},{"value":"SampleCompanyName","path":"/EmailAddress","op":"add"},{"path":"/PhoneNumber","op":"remove"},{"path":"/CorporateStreet1","op":"copy","from":"/LocalStreet1"},{"path":"/CorporateStreet1","op":"move","from":"/LocalStreet1"},{"value":"3140 Neil Armstrong Blvd","path":"/CorporateStreet1","op":"test"}]
},
"application/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": "\r\n \r\n \r\n replace\r\n /CorporateStreet1\r\n 3140 Neil Armstrong Blvd\r\n \r\n \r\n \r\n add\r\n /EmailAddress\r\n SampleCompanyName\r\n \r\n \r\n \r\n remove\r\n /PhoneNumber\r\n \r\n \r\n \r\n /LocalStreet1\r\n copy\r\n /CorporateStreet1\r\n \r\n \r\n \r\n /LocalStreet1\r\n move\r\n /CorporateStreet1\r\n \r\n \r\n \r\n \r\n test\r\n /CorporateStreet1\r\n 3140 Neil Armstrong Blvd\r\n \r\n"
},
"text/xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": "\r\n \r\n \r\n replace\r\n /CorporateStreet1\r\n 3140 Neil Armstrong Blvd\r\n \r\n \r\n \r\n add\r\n /EmailAddress\r\n SampleCompanyName\r\n \r\n \r\n \r\n remove\r\n /PhoneNumber\r\n \r\n \r\n \r\n /LocalStreet1\r\n copy\r\n /CorporateStreet1\r\n \r\n \r\n \r\n /LocalStreet1\r\n move\r\n /CorporateStreet1\r\n \r\n \r\n \r\n \r\n test\r\n /CorporateStreet1\r\n 3140 Neil Armstrong Blvd\r\n \r\n"
},
"application/*+xml": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation"
}
},
"example": "\r\n \r\n \r\n replace\r\n /CorporateStreet1\r\n 3140 Neil Armstrong Blvd\r\n \r\n \r\n \r\n add\r\n /EmailAddress\r\n SampleCompanyName\r\n \r\n \r\n \r\n remove\r\n /PhoneNumber\r\n \r\n \r\n \r\n /LocalStreet1\r\n copy\r\n /CorporateStreet1\r\n \r\n \r\n \r\n /LocalStreet1\r\n move\r\n /CorporateStreet1\r\n \r\n \r\n \r\n \r\n test\r\n /CorporateStreet1\r\n 3140 Neil Armstrong Blvd\r\n \r\n"
}
}
},
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Vendors/{id}/Contacts": {
"get": {
"tags": [
"Vendors"
],
"summary": "Get Vendor Contacts",
"description": "Gets contacts for a specific vendor.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): vendor-read ````",
"operationId": "VendorsByIdContactsGet",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The Id of the vendor",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "skip",
"in": "query",
"description": "The number of contacts to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of contacts to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Vendors.Service.Commands.VendorContactsQuery.Result, Vendors.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Vendors.Service.Commands.VendorContactsQuery.Result, Vendors.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Vendors.Service.Commands.VendorContactsQuery.Result, Vendors.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Vendors.Service.Commands.VendorContactsQuery.Result, Vendors.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Vendors.Service.Commands.VendorContactsQuery.Result, Vendors.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Vendors.Service.Commands.VendorContactsQuery.Result, Vendors.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Vendors.Service.Commands.VendorContactsQuery.Result, Vendors.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/Vendors/Indeed/Webhook/IndeedApplyIngest": {
"post": {
"tags": [
"Vendors"
],
"summary": "Create Applicant from Indeed Apply",
"description": "Creates an applicant from the Indeed Apply request\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): indeed-webhook ````",
"operationId": "VendorsIndeedWebhookIndeedApplyIngestPost",
"requestBody": {
"description": "Data from Indeed",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Vendors.API.Models.PostIndeedApplyIngestRequestModel"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Vendors.API.Models.PostIndeedApplyIngestRequestModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Vendors.API.Models.PostIndeedApplyIngestRequestModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Vendors.API.Models.PostIndeedApplyIngestRequestModel"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Vendors.API.Models.PostIndeedApplyIngestRequestModel"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Vendors.API.Models.PostIndeedApplyIngestRequestModel"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Vendors.API.Models.PostIndeedApplyIngestRequestModel"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Vendors.API.Models.PostIndeedApplyIngestRequestModel"
}
}
}
},
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/Vendors/Sense/Sync/{credentialsId}": {
"post": {
"tags": [
"Vendors"
],
"summary": "Manually triggers the recurring job to synchronize all entity type records.",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): externalservice-write ````",
"operationId": "VendorsSenseSyncByCredentialsIdPost",
"parameters": [
{
"name": "credentialsId",
"in": "path",
"description": "The unique identifier of the Sense external service credentials.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"202": {
"description": "Accepted"
}
}
},
"get": {
"tags": [
"Vendors"
],
"summary": "Gets status information for automated syncing process.",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): externalservice-write ````",
"operationId": "VendorsSenseSyncByCredentialsIdGet",
"parameters": [
{
"name": "credentialsId",
"in": "path",
"description": "The unique identifier of the Sense external service credentials.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sense.GetSenseSyncSystemInfo.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sense.GetSenseSyncSystemInfo.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sense.GetSenseSyncSystemInfo.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sense.GetSenseSyncSystemInfo.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sense.GetSenseSyncSystemInfo.Result"
}
}
}
}
}
}
},
"/Vendors/Sense/Sync/{originTypeId}/{originId}": {
"get": {
"tags": [
"Vendors"
],
"summary": "Gets status information for a specified origin record related to the Sense syncing process.",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): externalservice-write ````",
"operationId": "VendorsSenseSyncByOriginTypeIdByOriginIdGet",
"parameters": [
{
"name": "originTypeId",
"in": "path",
"description": "The origin type associated with the supplied origin ID.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "originId",
"in": "path",
"description": "The ID of the origin record to get information on.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sense.GetSenseOriginSyncInfo.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sense.GetSenseOriginSyncInfo.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sense.GetSenseOriginSyncInfo.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sense.GetSenseOriginSyncInfo.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sense.GetSenseOriginSyncInfo.Result"
}
}
}
}
}
},
"post": {
"tags": [
"Vendors"
],
"summary": "Manually syncs an origin record to Sense's system.",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): externalservice-write ````",
"operationId": "VendorsSenseSyncByOriginTypeIdByOriginIdPost",
"parameters": [
{
"name": "originTypeId",
"in": "path",
"description": "The ID of the origin to sync.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "originId",
"in": "path",
"description": "The origin type associated with the supplied origin ID.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/Vendors/Sovren/ConsentToUpload": {
"get": {
"tags": [
"Vendors"
],
"summary": "Get the consent to upload status for a specific Tenant",
"description": "Returns the consent to upload status for a specific Tenant.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): sovrensaas-read ````",
"operationId": "VendorsSovrenConsentToUploadGet",
"responses": {
"200": {
"description": "Consent to Upload Status.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sovren.Queries.GetConsentToUpload.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sovren.Queries.GetConsentToUpload.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sovren.Queries.GetConsentToUpload.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sovren.Queries.GetConsentToUpload.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sovren.Queries.GetConsentToUpload.Result"
}
}
}
},
"401": {
"description": "A message describing why the message was unauthorized."
}
}
},
"post": {
"tags": [
"Vendors"
],
"summary": "Authorizes consent to upload for a specific Tenant",
"description": "Causes the tenant to be included in our nightly parsing/matching upload when true.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): sovrensaas-write ````",
"operationId": "VendorsSovrenConsentToUploadPost",
"responses": {
"204": {
"description": "No Content"
},
"409": {
"description": "Conflict"
}
}
}
},
"/Vendors/Sovren/ImportSourcedResume": {
"post": {
"tags": [
"Vendors"
],
"summary": "Import a Sovren Sourced Resume",
"description": "Import a Sovren Sourced Resume and create a new Employee.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): sovrensaas-webhook ````",
"operationId": "VendorsSovrenImportSourcedResumePost",
"requestBody": {
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Vendors.API.Models.SovrenResumeImportRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Vendors.API.Models.SovrenResumeImportRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Vendors.API.Models.SovrenResumeImportRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Vendors.API.Models.SovrenResumeImportRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Vendors.API.Models.SovrenResumeImportRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Vendors.API.Models.SovrenResumeImportRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Vendors.API.Models.SovrenResumeImportRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.Vendors.API.Models.SovrenResumeImportRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sovren.ImportSovrenSourcedResume.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sovren.ImportSovrenSourcedResume.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sovren.ImportSovrenSourcedResume.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sovren.ImportSovrenSourcedResume.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sovren.ImportSovrenSourcedResume.Result"
}
}
}
}
}
}
},
"/Vendors/Sovren/JobBoardCredentials": {
"get": {
"tags": [
"Vendors"
],
"summary": "Get All Sovren Job Board Credentials",
"description": "Get all of the the Sovren Job Board Credentials visibile to the current API user. This requires the SourceAndMatchEdit and SourceAndMatchRead permissions.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): sovrensaas-read ````",
"operationId": "VendorsSovrenJobBoardCredentialsGet",
"responses": {
"200": {
"description": "Sovren Job Board Credentials.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Vendors.Service.Commands.Sovren.Models.SovrenUserJobBoardDetail, Vendors.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Vendors.Service.Commands.Sovren.Models.SovrenUserJobBoardDetail, Vendors.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Vendors.Service.Commands.Sovren.Models.SovrenUserJobBoardDetail, Vendors.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Vendors.Service.Commands.Sovren.Models.SovrenUserJobBoardDetail, Vendors.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Vendors.Service.Commands.Sovren.Models.SovrenUserJobBoardDetail, Vendors.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Vendors.Service.Commands.Sovren.Models.SovrenUserJobBoardDetail, Vendors.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Vendors.Service.Commands.Sovren.Models.SovrenUserJobBoardDetail, Vendors.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"403": {
"description": "Missing SourceAndMatchEdit/SourceAndMatchRead or integration is inactive"
}
}
}
},
"/Vendors/Sovren/JobBoardCredentials/{serviceRepId}": {
"get": {
"tags": [
"Vendors"
],
"summary": "Get Sovren Job Board Credentials",
"description": "Get the Sovren Job Board Credentials for a single Service Rep. This requires the SourceAndMatchRead permission.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): sovrensaas-read ````",
"operationId": "VendorsSovrenJobBoardCredentialsByServiceRepIdGet",
"parameters": [
{
"name": "serviceRepId",
"in": "path",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Sovren Job Board Credentials.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Vendors.Service.Commands.Sovren.Models.SovrenUserJobBoardDetail, Vendors.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Vendors.Service.Commands.Sovren.Models.SovrenUserJobBoardDetail, Vendors.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Vendors.Service.Commands.Sovren.Models.SovrenUserJobBoardDetail, Vendors.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Vendors.Service.Commands.Sovren.Models.SovrenUserJobBoardDetail, Vendors.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Vendors.Service.Commands.Sovren.Models.SovrenUserJobBoardDetail, Vendors.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Vendors.Service.Commands.Sovren.Models.SovrenUserJobBoardDetail, Vendors.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Vendors.Service.Commands.Sovren.Models.SovrenUserJobBoardDetail, Vendors.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"403": {
"description": "Missing SourceAndMatchRead or integration is inactive"
}
}
}
},
"/Vendors/Sovren/Matching/Employees/{employeeId}": {
"post": {
"tags": [
"Vendors"
],
"summary": "Generate Match UI URL for resume",
"description": "Generates a URL for rendering the Sovren matching UI, which allows finding job orders which are a good fit for this employee's most recently added resume.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): sovrensaas-read ````",
"operationId": "VendorsSovrenMatchingEmployeesByEmployeeIdPost",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The client hooks.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.Sovren.Service.Models.Hooks"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.Sovren.Service.Models.Hooks"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.Sovren.Service.Models.Hooks"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.Sovren.Service.Models.Hooks"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.Sovren.Service.Models.Hooks"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.Sovren.Service.Models.Hooks"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.Sovren.Service.Models.Hooks"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.Sovren.Service.Models.Hooks"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sovren.Commands.GenerateMatchForEmployee.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sovren.Commands.GenerateMatchForEmployee.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sovren.Commands.GenerateMatchForEmployee.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sovren.Commands.GenerateMatchForEmployee.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sovren.Commands.GenerateMatchForEmployee.Result"
}
}
}
}
}
}
},
"/Vendors/Sovren/Matching/Employees/{employeeId}/Metadata": {
"get": {
"tags": [
"Vendors"
],
"summary": "Confirms that MatchUI is available",
"description": "Confirms that a MatchUI can be generated or, if it can't, explains why.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): sovrensaas-read ````",
"operationId": "VendorsSovrenMatchingEmployeesByEmployeeIdMetadataGet",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sovren.Queries.GetSovrenEmployeeMetadata.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sovren.Queries.GetSovrenEmployeeMetadata.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sovren.Queries.GetSovrenEmployeeMetadata.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sovren.Queries.GetSovrenEmployeeMetadata.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sovren.Queries.GetSovrenEmployeeMetadata.Result"
}
}
}
}
}
}
},
"/Vendors/Sovren/Matching/JobOrders/{jobOrderId}": {
"post": {
"tags": [
"Vendors"
],
"summary": "Generate Match UI URL for Job Order",
"description": "Generates a URL for rendering the Sovren matching UI, which allows finding employees which are a good fit for this job order.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): sovrensaas-read ````",
"operationId": "VendorsSovrenMatchingJobOrdersByJobOrderIdPost",
"parameters": [
{
"name": "jobOrderId",
"in": "path",
"description": "The Id of the job order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The client hooks.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.Sovren.Service.Models.Hooks"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.Sovren.Service.Models.Hooks"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.Sovren.Service.Models.Hooks"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.Sovren.Service.Models.Hooks"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.Sovren.Service.Models.Hooks"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.Sovren.Service.Models.Hooks"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.Sovren.Service.Models.Hooks"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.Sovren.Service.Models.Hooks"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sovren.Commands.GenerateMatchForJobOrder.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sovren.Commands.GenerateMatchForJobOrder.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sovren.Commands.GenerateMatchForJobOrder.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sovren.Commands.GenerateMatchForJobOrder.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sovren.Commands.GenerateMatchForJobOrder.Result"
}
}
}
}
}
}
},
"/Vendors/Sovren/Matching/JobOrders/{jobOrderId}/Metadata": {
"get": {
"tags": [
"Vendors"
],
"summary": "Confirms that MatchUI is available",
"description": "Confirms that a MatchUI can be generated or, if it can't, explains why.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): sovrensaas-read ````",
"operationId": "VendorsSovrenMatchingJobOrdersByJobOrderIdMetadataGet",
"parameters": [
{
"name": "jobOrderId",
"in": "path",
"description": "The Id of the Job Order.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sovren.Queries.GetSovrenJobOrderMetadata.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sovren.Queries.GetSovrenJobOrderMetadata.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sovren.Queries.GetSovrenJobOrderMetadata.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sovren.Queries.GetSovrenJobOrderMetadata.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sovren.Queries.GetSovrenJobOrderMetadata.Result"
}
}
}
}
}
}
},
"/Vendors/Sovren/Searching": {
"post": {
"tags": [
"Vendors"
],
"summary": "Generate Sovren URL for search",
"description": "Generates a URL for rendering the Sovren Searching UI\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): sovrensaas-read ````",
"operationId": "VendorsSovrenSearchingPost",
"requestBody": {
"description": "The client hooks.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.Sovren.Service.Models.Hooks"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.Sovren.Service.Models.Hooks"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.Sovren.Service.Models.Hooks"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.Sovren.Service.Models.Hooks"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.Sovren.Service.Models.Hooks"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.Sovren.Service.Models.Hooks"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.Sovren.Service.Models.Hooks"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.Sovren.Service.Models.Hooks"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sovren.Commands.GenerateSearch.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sovren.Commands.GenerateSearch.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sovren.Commands.GenerateSearch.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sovren.Commands.GenerateSearch.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sovren.Commands.GenerateSearch.Result"
}
}
}
}
}
}
},
"/Vendors/Sovren/Searching/Metadata": {
"get": {
"tags": [
"Vendors"
],
"summary": "Confirms that MatchUI is available",
"description": "Confirms that a MatchUI can be generated or, if it can't, explains why.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): sovrensaas-read ````",
"operationId": "VendorsSovrenSearchingMetadataGet",
"parameters": [
{
"name": "employeeId",
"in": "path",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sovren.Queries.GetSovrenSearchMetadata.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sovren.Queries.GetSovrenSearchMetadata.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sovren.Queries.GetSovrenSearchMetadata.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sovren.Queries.GetSovrenSearchMetadata.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sovren.Queries.GetSovrenSearchMetadata.Result"
}
}
}
}
}
}
},
"/Vendors/Sovren/Users/{serviceRepId}/JobBoards": {
"post": {
"tags": [
"Vendors"
],
"summary": "Create a job board for a Sovren user account",
"description": "Add job board credentials to a Sovren user account.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): sovrensaas-write ````",
"operationId": "VendorsSovrenUsersByServiceRepIdJobBoardsPost",
"parameters": [
{
"name": "serviceRepId",
"in": "path",
"description": "The Id of the service rep with the Job Board account to create.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"description": "The Sovren user object containing job board credentials.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ExternalServices.SovrenJobBoard"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ExternalServices.SovrenJobBoard"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ExternalServices.SovrenJobBoard"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ExternalServices.SovrenJobBoard"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ExternalServices.SovrenJobBoard"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ExternalServices.SovrenJobBoard"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ExternalServices.SovrenJobBoard"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ExternalServices.SovrenJobBoard"
}
}
}
},
"responses": {
"201": {
"description": "Created"
},
"401": {
"description": "The request was unauthorized."
}
}
}
},
"/Vendors/Sovren/Users/{serviceRepId}/JobBoards/{jobBoardName}": {
"get": {
"tags": [
"Vendors"
],
"summary": "Get a job board for a Sovren user account",
"description": "Get the job board credentials for a Sovren user account. This requires the SourceAndMatchRead permissions.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): sovrensaas-read ````",
"operationId": "VendorsSovrenUsersByServiceRepIdJobBoardsByJobBoardNameGet",
"parameters": [
{
"name": "serviceRepId",
"in": "path",
"description": "The Id of the service rep with the Job Board account to get.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "jobBoardName",
"in": "path",
"description": "The name of the job board.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Sovren Job Board Account.",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sovren.Queries.GetSovrenJobBoardAccount.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sovren.Queries.GetSovrenJobBoardAccount.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sovren.Queries.GetSovrenJobBoardAccount.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sovren.Queries.GetSovrenJobBoardAccount.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sovren.Queries.GetSovrenJobBoardAccount.Result"
}
}
}
},
"403": {
"description": "Missing SourceAndMatchRead or integration is inactive"
}
}
},
"put": {
"tags": [
"Vendors"
],
"summary": "Edit a job board for a Sovren user account",
"description": "Update job board credentials for a Sovren user account.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): sovrensaas-write ````",
"operationId": "VendorsSovrenUsersByServiceRepIdJobBoardsByJobBoardNamePut",
"parameters": [
{
"name": "serviceRepId",
"in": "path",
"description": "The Id of the service rep with the Job Board account to edit.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "jobBoardName",
"in": "path",
"description": "The name of the job board.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The Sovren user object containing job board credentials.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ExternalServices.SovrenJobBoard"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ExternalServices.SovrenJobBoard"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ExternalServices.SovrenJobBoard"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ExternalServices.SovrenJobBoard"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ExternalServices.SovrenJobBoard"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ExternalServices.SovrenJobBoard"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ExternalServices.SovrenJobBoard"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Models.ExternalServices.SovrenJobBoard"
}
}
}
},
"responses": {
"204": {
"description": "No content"
},
"401": {
"description": "The request was unauthorized."
}
}
},
"delete": {
"tags": [
"Vendors"
],
"summary": "Delete a job board from a Sovren user account",
"description": "Delete job board credentials from a Sovren user account.\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): sovrensaas-write ````",
"operationId": "VendorsSovrenUsersByServiceRepIdJobBoardsByJobBoardNameDelete",
"parameters": [
{
"name": "serviceRepId",
"in": "path",
"description": "The Id of the Service Rep with the Job Board Account to remove. Currently, this must be the ServiceRepId of the authenticated API User.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "jobBoardName",
"in": "path",
"description": "The name of the Job Board Account to remove.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"401": {
"description": "The request was unauthorized."
}
}
}
},
"/Vendors/Sovren/Users/{serviceRepId}/JobBoards/{jobBoardName}/ToggleActive": {
"put": {
"tags": [
"Vendors"
],
"summary": "Toggle the IsActive flag on a job board.",
"description": "Toggle the active flag on a job board of a Sovren user account\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): sovrensaas-write ````",
"operationId": "VendorsSovrenUsersByServiceRepIdJobBoardsByJobBoardNameToggleActivePut",
"parameters": [
{
"name": "serviceRepId",
"in": "path",
"description": "The Id of the service rep with the Job Board account to toggle the IsActive.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "jobBoardName",
"in": "path",
"description": "The name of the job board being activated or deactivated.",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"401": {
"description": "The request was unauthorized."
}
}
}
},
"/WebUsers/{originTypeId}/DefaultProductInstances": {
"get": {
"tags": [
"WebUsers"
],
"summary": "Get the Origin Default Product Instance",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): webuser-write ````",
"operationId": "WebUsersByOriginTypeIdDefaultProductInstancesGet",
"parameters": [
{
"name": "originTypeId",
"in": "path",
"description": "The id of the originType.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.GetDefaultProductInstancesForOriginTypeQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.GetDefaultProductInstancesForOriginTypeQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.GetDefaultProductInstancesForOriginTypeQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.GetDefaultProductInstancesForOriginTypeQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.GetDefaultProductInstancesForOriginTypeQuery.Result"
}
}
}
}
}
}
},
"/WebUsers/PrevalidateUsername": {
"post": {
"tags": [
"WebUsers"
],
"summary": "Pre-validate Web User Username",
"description": "Checks to see if the username is available as well as other validation checks. If it is not valid, it will throw a\r\n400 with validation errors or a 409 if it is already taken\n \n```` Allows roles: Service, ServiceRep ````\n \n```` Requires scope(s): webuser-write ````",
"operationId": "WebUsersPrevalidateUsernamePost",
"parameters": [
{
"name": "username",
"in": "query",
"description": "The username to check",
"style": "form",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/WebUsers/ResetPassword": {
"post": {
"tags": [
"WebUsers"
],
"summary": "Request a password reset for the user.\r\nThe user receives an email with a code that they can use to reset their password.\r\nCall ResetPassword/ValidateCode to validate the code.",
"description": "\n \n```` Allows roles: Service ````\n \n```` Requires scope(s): webuser-write ````",
"operationId": "WebUsersResetPasswordPost",
"requestBody": {
"description": "A request model containing the username requesting a password reset, the sender name, and optional branding image to include in the email",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.WebUsers.WebUserResetPasswordRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.WebUsers.WebUserResetPasswordRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.WebUsers.WebUserResetPasswordRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.WebUsers.WebUserResetPasswordRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.WebUsers.WebUserResetPasswordRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.WebUsers.WebUserResetPasswordRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.WebUsers.WebUserResetPasswordRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.WebUsers.WebUserResetPasswordRequest"
}
}
}
},
"responses": {
"202": {
"description": "Accepted"
}
}
}
},
"/WebUsers/ResetPassword/ValidateCode": {
"post": {
"tags": [
"WebUsers"
],
"summary": "Validates a code from a web user password reset request.\r\nA given code can only be used once.",
"description": "\n \n```` Allows roles: Service ````\n \n```` Requires scope(s): webuser-write ````",
"operationId": "WebUsersResetPasswordValidateCodePost",
"requestBody": {
"description": "A request model containing the username and the code",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.WebUsers.WebUserResetPasswordValidateCodeRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.WebUsers.WebUserResetPasswordValidateCodeRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.WebUsers.WebUserResetPasswordValidateCodeRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.WebUsers.WebUserResetPasswordValidateCodeRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.WebUsers.WebUserResetPasswordValidateCodeRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.WebUsers.WebUserResetPasswordValidateCodeRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.WebUsers.WebUserResetPasswordValidateCodeRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.WebUsers.WebUserResetPasswordValidateCodeRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.WebUsers.WebUserValidateResetPasswordCode.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.WebUsers.WebUserValidateResetPasswordCode.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.WebUsers.WebUserValidateResetPasswordCode.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.WebUsers.WebUserValidateResetPasswordCode.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.WebUsers.WebUserValidateResetPasswordCode.Result"
}
}
}
}
}
}
},
"/WebUsers/validate": {
"post": {
"tags": [
"WebUsers"
],
"summary": "Validate Web User Credentials. Returns OriginId and OriginTypeId if the passed in username and password are valid.",
"description": "\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): webuser-write ````",
"operationId": "WebUsersValidatePost",
"requestBody": {
"description": "Body of the request will contain the user provided username and password to be validated.",
"content": {
"application/vnd.textus+jsonld": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.WebUserValidateCredentialsRequest"
}
},
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.WebUserValidateCredentialsRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.WebUserValidateCredentialsRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.WebUserValidateCredentialsRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.WebUserValidateCredentialsRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.WebUserValidateCredentialsRequest"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.WebUserValidateCredentialsRequest"
}
},
"application/*+xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.WebUser.WebUserValidateCredentialsRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.GetOriginInfoForWebUserQuery.Result"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.GetOriginInfoForWebUserQuery.Result"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.GetOriginInfoForWebUserQuery.Result"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.GetOriginInfoForWebUserQuery.Result"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.GetOriginInfoForWebUserQuery.Result"
}
}
}
}
}
}
},
"/YearEnd/Employees/{employeeId}/TaxFormBytes": {
"get": {
"tags": [
"YearEnd"
],
"summary": "Generate Year End Employee Tax Form Pdf",
"description": "Generates a PDF or zip archive of the specified year end tax form for the specified employee.\n \n```` Allows roles: ServiceRep, WebUserEmployee ````\n \n```` Requires scope(s): yearend-employee-read ````",
"operationId": "YearEndEmployeesByEmployeeIdTaxFormBytesGet",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "productId",
"in": "query",
"description": "Used to filter the tax forms list so that only tax forms usable by the specified product are returned. ProductIds are 1 = Enterprise, 2 = Beyond, 4 = WebCenter",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "TaxFormTypeId",
"in": "query",
"description": "The TaxFormTypeId of the form to generate.\r\nValid values can be found in the YearEndEmployeeTaxFormTypes datalist. ref: /yearend/employees/taxformtypes",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Year",
"in": "query",
"description": "The Year of the form to generate. Only years 2015 and later are supported.\r\nCertain tax form types may have other year restrictions.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "EmployerId",
"in": "query",
"description": "The EmployerId of the form to generate.",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "string",
"format": "binary"
}
},
"application/json": {
"schema": {
"type": "string",
"format": "binary"
}
},
"text/json": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
}
}
}
},
"/YearEnd/Employees/{employeeId}/TaxForms": {
"get": {
"tags": [
"YearEnd"
],
"summary": "Get Year End Employee Tax Forms",
"description": "Gets a list of year end tax forms for the specified employee.\n \n```` Allows roles: ServiceRep, WebUserEmployee ````\n \n```` Requires scope(s): yearend-employee-read ````",
"operationId": "YearEndEmployeesByEmployeeIdTaxFormsGet",
"parameters": [
{
"name": "employeeId",
"in": "path",
"description": "The Id of the employee.",
"required": true,
"style": "simple",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "productId",
"in": "query",
"description": "Used to filter the tax forms list so that only tax forms usable by the specified product are returned. ProductIds are 1 = Enterprise, 2 = Beyond, 4 = WebCenter",
"required": true,
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "TaxFormTypeId",
"in": "query",
"description": "Optional filter criteria to limit the returned results to the provided TaxFormTypeId.\r\nValid values can be found in the YearEndTaxFormTypes datalist, filtered to IsEmployeeRelevant=true. ref: /datalists/yearEndTaxFormTypes",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Year",
"in": "query",
"description": "Optional filter criteria to limit the returned results to the provided Year.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "EmployerId",
"in": "query",
"description": "Optional filter criteria to limit the returned results to the provided EmployerId.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "CanGenerateForm",
"in": "query",
"description": "Optional filter criteria to limit the returned results to tax forms that can be generated and downloaded as a PDF through the API.",
"style": "form",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.YearEnd.Service.Commands.YearEndEmployeeTaxForms.Result, YearEnd.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.YearEnd.Service.Commands.YearEndEmployeeTaxForms.Result, YearEnd.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.YearEnd.Service.Commands.YearEndEmployeeTaxForms.Result, YearEnd.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.YearEnd.Service.Commands.YearEndEmployeeTaxForms.Result, YearEnd.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.YearEnd.Service.Commands.YearEndEmployeeTaxForms.Result, YearEnd.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.YearEnd.Service.Commands.YearEndEmployeeTaxForms.Result, YearEnd.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.YearEnd.Service.Commands.YearEndEmployeeTaxForms.Result, YearEnd.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
},
"/YearEnd/Employees/TaxFormTypes": {
"get": {
"tags": [
"YearEnd"
],
"summary": "Get Year End Employee Tax Form Types",
"description": "Returns a list of Year End Tax Form Types filtered to those forms which are sent to the employee, and ordered by TaxFormTypeName\n \n```` Allows roles: ServiceRep ````\n \n```` Requires scope(s): yearend-employee-read ````",
"operationId": "YearEndEmployeesTaxFormTypesGet",
"parameters": [
{
"name": "skip",
"in": "query",
"description": "The number of items to skip. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
}
},
{
"name": "take",
"in": "query",
"description": "The number of items to return. Used for paging.",
"style": "form",
"schema": {
"type": "integer",
"format": "int32",
"default": 1000
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.YearEnd.Service.Commands.YearEndTaxFormTypes.Result, YearEnd.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.YearEnd.Service.Commands.YearEndTaxFormTypes.Result, YearEnd.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.YearEnd.Service.Commands.YearEndTaxFormTypes.Result, YearEnd.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.YearEnd.Service.Commands.YearEndTaxFormTypes.Result, YearEnd.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.YearEnd.Service.Commands.YearEndTaxFormTypes.Result, YearEnd.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.YearEnd.Service.Commands.YearEndTaxFormTypes.Result, YearEnd.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.YearEnd.Service.Commands.YearEndTaxFormTypes.Result, YearEnd.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"Microsoft.AspNetCore.JsonPatch.Operations.Operation": {
"type": "object",
"properties": {
"value": {
"nullable": true
},
"path": {
"type": "string",
"nullable": true
},
"op": {
"type": "string",
"nullable": true
},
"from": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Microsoft.AspNetCore.Mvc.ValidationProblemDetails": {
"type": "object",
"properties": {
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
},
"nullable": true
},
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
},
"additionalProperties": { }
},
"TempWorks.TwApi.Common.Models.Address": {
"type": "object",
"properties": {
"attentionTo": {
"type": "string",
"nullable": true
},
"street1": {
"type": "string",
"nullable": true
},
"street2": {
"type": "string",
"nullable": true
},
"municipality": {
"type": "string",
"nullable": true
},
"region": {
"type": "string",
"nullable": true
},
"postalCode": {
"type": "string",
"nullable": true
},
"country": {
"type": "string",
"nullable": true
},
"countryCode": {
"type": "integer",
"format": "int32",
"nullable": true
},
"location": {
"$ref": "#/components/schemas/TempWorks.TwApi.Common.Models.GeoCoordinate"
},
"dateAddressStandardized": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"TempWorks.TwApi.Common.Models.ExtendedAddress": {
"type": "object",
"properties": {
"municipalityId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"county": {
"type": "string",
"nullable": true
},
"countyId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"schoolDistrict": {
"type": "string",
"nullable": true
},
"schoolDistrictId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"schoolJurisId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"psdCode": {
"type": "string",
"nullable": true
},
"attentionTo": {
"type": "string",
"nullable": true
},
"street1": {
"type": "string",
"nullable": true
},
"street2": {
"type": "string",
"nullable": true
},
"municipality": {
"type": "string",
"nullable": true
},
"region": {
"type": "string",
"nullable": true
},
"postalCode": {
"type": "string",
"nullable": true
},
"country": {
"type": "string",
"nullable": true
},
"countryCode": {
"type": "integer",
"format": "int32",
"nullable": true
},
"location": {
"$ref": "#/components/schemas/TempWorks.TwApi.Common.Models.GeoCoordinate"
},
"dateAddressStandardized": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"TempWorks.TwApi.Common.Models.GeoCoordinate": {
"type": "object",
"properties": {
"latitude": {
"type": "number",
"format": "double"
},
"longitude": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"TempWorks.TwApi.Common.Models.LocalizedJobOrderSchedule": {
"type": "object",
"properties": {
"locale": {
"type": "string",
"nullable": true
},
"shiftNotes": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TempWorks.TwApi.Common.Models.LocalizedJobTitles": {
"type": "object",
"properties": {
"locale": {
"type": "string",
"nullable": true
},
"jobTitle": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TempWorks.TwApi.Common.Models.LocalizedShiftValues": {
"type": "object",
"properties": {
"locale": {
"type": "string",
"nullable": true
},
"shiftName": {
"type": "string",
"nullable": true
},
"shiftNotes": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TempWorks.TwApi.Common.Models.LocalizedWorksiteDetails": {
"type": "object",
"properties": {
"locale": {
"type": "string",
"nullable": true
},
"dressCode": {
"type": "string",
"nullable": true
},
"directions": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TempWorks.TwApi.Common.Models.SalesTax": {
"type": "object",
"properties": {
"salesTaxJurisdictionId": {
"type": "string",
"format": "uuid"
},
"salesTaxJurisdiction": {
"type": "string",
"nullable": true
},
"salesTaxJurisdictionDescription": {
"type": "string",
"nullable": true
},
"salesTaxTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TempWorks.TwApi.Common.Models.TaxType"
},
"nullable": true
}
},
"additionalProperties": false
},
"TempWorks.TwApi.Common.Models.StandardizedAddress": {
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true
},
"street1": {
"type": "string",
"nullable": true
},
"street2": {
"type": "string",
"nullable": true
},
"municipality": {
"type": "string",
"nullable": true
},
"region": {
"type": "string",
"nullable": true
},
"postalCode": {
"type": "string",
"nullable": true
},
"responseCodes": {
"type": "string",
"nullable": true
},
"error": {
"type": "string",
"nullable": true
},
"errorDescription": {
"type": "string",
"nullable": true
},
"returnText": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TempWorks.TwApi.Common.Models.TaxType": {
"type": "object",
"properties": {
"salesTaxPercentage": {
"type": "number",
"format": "double",
"nullable": true
},
"salesTaxType": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Common.Enums.ActorType": {
"enum": [
1,
2
],
"type": "integer",
"format": "int32"
},
"TwApi.Common.Enums.CardSize": {
"enum": [
0,
1
],
"type": "integer",
"format": "int32"
},
"TwApi.Common.Enums.CustomerRoleConflictResolutionApproach": {
"enum": [
0,
1,
2
],
"type": "integer",
"format": "int32"
},
"TwApi.Common.Enums.EmailFormat": {
"enum": [
0,
1,
2,
3,
4,
5
],
"type": "integer",
"format": "int32"
},
"TwApi.Common.Enums.EmailServiceType": {
"enum": [
1,
2,
3,
4
],
"type": "integer",
"format": "int32"
},
"TwApi.Common.Enums.FilterByStatusType": {
"enum": [
0,
1,
2,
3,
4,
5
],
"type": "integer",
"format": "int32"
},
"TwApi.Common.Enums.GenderType": {
"enum": [
0,
1,
2,
3
],
"type": "integer",
"format": "int32"
},
"TwApi.Common.Enums.HotlistType": {
"enum": [
1,
2,
3
],
"type": "integer",
"format": "int32"
},
"TwApi.Common.Enums.MsExchangeSensitivity": {
"enum": [
0,
1,
2,
3
],
"type": "integer",
"format": "int32"
},
"TwApi.Common.Enums.OfferStatusType": {
"enum": [
0,
1,
2,
3
],
"type": "integer",
"format": "int32"
},
"TwApi.Common.Enums.OriginType": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
26,
27,
28,
29,
30,
31,
32,
33,
34,
35,
36,
37,
38,
39,
40,
41,
42,
43,
44,
45,
46,
47,
48,
49,
50,
51,
52,
53,
54,
55,
56,
57,
58,
59,
60,
61,
62,
63,
64,
65,
66,
67,
68,
69,
70,
71,
72,
75,
76,
77,
78,
79,
80,
81,
83,
84,
85,
86,
87,
88,
89,
90,
91,
92,
93,
94,
95,
96,
97,
98,
99,
100,
101,
102,
103,
104
],
"type": "integer",
"format": "int32"
},
"TwApi.Common.Enums.PaycheckQueryTypes": {
"enum": [
1,
2,
3
],
"type": "integer",
"format": "int32"
},
"TwApi.Common.Enums.Products": {
"enum": [
1,
2,
4,
8,
16,
32,
64,
128,
256,
512,
1024,
2048
],
"type": "integer",
"format": "int32"
},
"TwApi.Common.Enums.TaskQueryTypes": {
"enum": [
0,
1,
2
],
"type": "integer",
"format": "int32"
},
"TwApi.Common.Enums.TimeclockProductType": {
"enum": [
1,
2
],
"type": "integer",
"format": "int32"
},
"TwApi.Common.Infrastructure.CursorPagedList`1[[TwApi.Services.System.Service.Commands.MessageStreamQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.MessageStreamQuery.Result"
},
"nullable": true
},
"nextId": {
"type": "integer",
"format": "int64",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TempWorks.TwApi.Common.Models.SalesTax, TempWorks.TwApi.Common.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TempWorks.TwApi.Common.Models.SalesTax"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.AssignmentRestrictions.EmployeeCustomerDoNotAssign, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.AssignmentRestrictions.EmployeeCustomerDoNotAssign"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.ContactMethods.EntityContactMethod, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMethods.EntityContactMethod"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Models.Messages.MessageSummary, TwAPI.Common, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageSummary"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Common.Shared.Models.Configuration.ProductConfiguration, Shared.Models, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Configuration.ProductConfiguration"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.ExternalIntegrations.PowerBiCloud.Service.Commands.GetPowerBiWorkspaceDatasets.Result, PowerBiCloud.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.PowerBiCloud.Service.Commands.GetPowerBiWorkspaceDatasets.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.ExternalIntegrations.PowerBiCloud.Service.Commands.GetPowerBiWorkspaceReports.Result, PowerBiCloud.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.PowerBiCloud.Service.Commands.GetPowerBiWorkspaceReports.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.ExternalIntegrations.PowerBiCloud.Service.Commands.GetPowerBiWorkspaces.Result, PowerBiCloud.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.PowerBiCloud.Service.Commands.GetPowerBiWorkspaces.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Assignments.AssignmentSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Messages.Assignments.AssignmentSearch.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Assignments.AssignmentTimeclockPunchList.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Messages.Assignments.AssignmentTimeclockPunchList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.BackgroundChecks.BackgroundChecksSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Messages.BackgroundChecks.BackgroundChecksSearch.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Branches.BranchList.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Messages.Branches.BranchList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.CustomData.GetPropertyDefinitions.Response, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Messages.CustomData.GetPropertyDefinitions.Response"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Notifications.UserNotificationUnsubscriptionsQuery.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Messages.Notifications.UserNotificationUnsubscriptionsQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Onboarding.Onboarding2ActionMetadataByEmployeeSearch.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Messages.Onboarding.Onboarding2ActionMetadataByEmployeeSearch.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Onboarding.Onboarding2ActionMetadataEmployeeList.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Messages.Onboarding.Onboarding2ActionMetadataEmployeeList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Timeclock.OnSiteTimeClockAuthDataQuery.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Messages.Timeclock.OnSiteTimeClockAuthDataQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Messages.Timeclock.TimeclockPunchMessageData.Result, TwApi.Messages, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Messages.Timeclock.TimeclockPunchMessageData.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.AssessmentOrgsQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.AssessmentOrgsQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.AssessmentPackagesQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.AssessmentPackagesQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.AssessmentSessionFormFieldsQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.AssessmentSessionFormFieldsQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.AssessmentSessionsQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.AssessmentSessionsQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.AssessmentVendorsQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.AssessmentVendorsQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.AssessmentsQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.AssessmentsQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.LocalesQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.LocalesQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.UserDefinedPackageMembersQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.UserDefinedPackageMembersQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assessments.Service.Commands.UserDefinedPackagesQuery.Result, Assessments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.UserDefinedPackagesQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assignments.Service.Commands.Accruals.AssignmentAccrualsList.Result, Assignments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.Accruals.AssignmentAccrualsList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assignments.Service.Commands.Adjustments.AssignmentAdjustments.Result, Assignments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.Adjustments.AssignmentAdjustments.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assignments.Service.Commands.AssignmentAllocationQuery.Result, Assignments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.AssignmentAllocationQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Assignments.Service.Commands.AssignmentDirectHirePlacementFees.Result, Assignments.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Assignments.Service.Commands.AssignmentDirectHirePlacementFees.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Contacts.Service.Commands.InterestCodes.ContactInterestCodesQuery.Result, Contacts.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.Service.Commands.InterestCodes.ContactInterestCodesQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.AbsenceReasons.CustomerAbsenceReasonsQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.AbsenceReasons.CustomerAbsenceReasonsQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.Accruals.CustomerAccrualsList.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.Accruals.CustomerAccrualsList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.BillingSetup.CustomerInvoiceLineItemDetailsQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.BillingSetup.CustomerInvoiceLineItemDetailsQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerContactMessagesQuery.CustomerMessageSummary, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerContactMessagesQuery.CustomerMessageSummary"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerContactsInRolesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerContactsInRolesQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerContactsQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerContactsQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerDefaultJobDescriptions.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerDefaultJobDescriptions.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerDefaultMultiplierCodesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerDefaultMultiplierCodesQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerDefaultRequiredDocumentTypes.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerDefaultRequiredDocumentTypes.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerDefaultShiftsQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerDefaultShiftsQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerDefaultWorkerCompCodesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerDefaultWorkerCompCodesQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerFetchSalesPipeline.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerFetchSalesPipeline.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerInvoiceHistoryQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerInvoiceHistoryQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerMultiplierCodesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerMultiplierCodesQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerOrdersQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerOrdersQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.CustomerWorkerCompCodesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerWorkerCompCodesQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.InterestCodes.CustomerInterestCodesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.InterestCodes.CustomerInterestCodesQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.PurchaseOrders.CustomerPurchaseOrdersQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.PurchaseOrders.CustomerPurchaseOrdersQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.Vendors.CustomerVendorsList.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.Vendors.CustomerVendorsList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Customers.Service.Commands.Worksite.CustomerWorksitesQuery.Result, Customers.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.Worksite.CustomerWorksitesQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AcaEmployeeAdjustmentTypeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.AcaEmployeeAdjustmentTypeListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AcaEmploymentStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.AcaEmploymentStatusListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AccrualList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.AccrualList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AccrualTierDataListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.AccrualTierDataListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AdjustmentAuthoritiesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.AdjustmentAuthoritiesListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AdjustmentCategoriesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.AdjustmentCategoriesList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AdjustmentFrequenciesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.AdjustmentFrequenciesListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AdjustmentRuleCaseRuleColumnsListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.AdjustmentRuleCaseRuleColumnsListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AdjustmentRuleCaseRuleConstraintTypesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.AdjustmentRuleCaseRuleConstraintTypesListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.AssignmentStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.AssignmentStatusListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.BackgroundCheckStatusTypesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.BackgroundCheckStatusTypesList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.BankAccountListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.BankAccountListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.BatchJobItemStatusList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.BatchJobItemStatusList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.BillingFrequencyListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.BillingFrequencyListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.BiometricsImageAngleListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.BiometricsImageAngleListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ColorComboList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.ColorComboList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CommissionCreditTypeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.CommissionCreditTypeListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ContactRoleListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.ContactRoleListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ContactStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.ContactStatusListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CreditHoldCodeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.CreditHoldCodeListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CurrenciesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.CurrenciesListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CustomDataPropertyTypeQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.CustomDataPropertyTypeQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CustomDataSupportedOriginTypesQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.CustomDataSupportedOriginTypesQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CustomerInvoiceLineItemDetailListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.CustomerInvoiceLineItemDetailListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.CustomerTypeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.CustomerTypeListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ElectronicPayAccountTypesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.ElectronicPayAccountTypesListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ElectronicPayBankTypesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.ElectronicPayBankTypesListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.EmailAccountsList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.EmailAccountsList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.EmailServiceTypesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.EmailServiceTypesList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.EmailSignaturesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.EmailSignaturesList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.InterviewQuestionCategoryList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.InterviewQuestionCategoryList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.InterviewQuestionTypeList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.InterviewQuestionTypeList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.InterviewQuestionsByCategoryIdList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.InterviewQuestionsByCategoryIdList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.InvoiceEmailTemplateListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.InvoiceEmailTemplateListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.InvoiceHandlingListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.InvoiceHandlingListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.InvoiceReportListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.InvoiceReportListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.JobOrderCandidateStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.JobOrderCandidateStatusListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.JobOrderDurationListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.JobOrderDurationListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.JobOrderStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.JobOrderStatusListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.KpiReportTypesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.KpiReportTypesList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.MaritalTaxStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.MaritalTaxStatusListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.MonthlyBillCycleListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.MonthlyBillCycleListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.MonthlyPayCyclesListByPayPeriodQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.MonthlyPayCyclesListByPayPeriodQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.MonthlyPayCyclesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.MonthlyPayCyclesListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.NationalIndustryClassificationSystemCodeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.NationalIndustryClassificationSystemCodeListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.PayCodeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.PayCodeListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.PayTransparencyCollectionTypeBasisListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.PayTransparencyCollectionTypeBasisListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.PayTransparencyCollectionTypeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.PayTransparencyCollectionTypeListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.PayTransparencyGenderListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.PayTransparencyGenderListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.PayTransparencyRaceListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.PayTransparencyRaceListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.PaycheckDeliveryCodeListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.PaycheckDeliveryCodeListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ProspectStatusList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.ProspectStatusList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.RemoteWorkStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.RemoteWorkStatusListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ResumeFileTypeList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.ResumeFileTypeList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ResumeTemplateListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.ResumeTemplateListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.RoutingNumbersListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.RoutingNumbersListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.SalesPipelineStatusListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.SalesPipelineStatusListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.SalesTaxTypesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.SalesTaxTypesList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ServiceRepTeamListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.ServiceRepTeamListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ServiceRepTeamMembersListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.ServiceRepTeamMembersListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.ShiftList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.ShiftList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.SmtpEncryptionMethodsList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.SmtpEncryptionMethodsList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.SovrenJobBoardsList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.SovrenJobBoardsList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.TemplateCategoryList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.TemplateCategoryList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.TemplateCategoryTemplatesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.TemplateCategoryTemplatesList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.TemplateDataSourcesList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.TemplateDataSourcesList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.TemplateTypeList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.TemplateTypeList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.TextMessageProviderList.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.TextMessageProviderList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Datalists.Service.Commands.TimeClockTimeZoneListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Datalists.Service.Commands.TimeClockTimeZoneListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Email.Service.Commands.GetEmailBatchEmails.Result, Email.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Email.Service.Commands.GetEmailBatchEmails.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Email.Service.Commands.SentEmailBatches.Result, Email.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Email.Service.Commands.SentEmailBatches.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Accruals.EmployeeAccrualBalanceList.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.Accruals.EmployeeAccrualBalanceList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Accruals.EmployeeAccrualHistoryList.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.Accruals.EmployeeAccrualHistoryList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Accruals.EmployeeAccrualsList.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.Accruals.EmployeeAccrualsList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Adjustments.CreateEmployeeAdjustmentCommand.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.Adjustments.CreateEmployeeAdjustmentCommand.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Adjustments.EmployeeAdjustmentDetailsQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.Adjustments.EmployeeAdjustmentDetailsQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Adjustments.EmployeeAdjustmentsQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.Adjustments.EmployeeAdjustmentsQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.AssignedEmployeeInterviewCategories.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.AssignedEmployeeInterviewCategories.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.AssignedEmployeeInterviewQuestions.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.AssignedEmployeeInterviewQuestions.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.AssignedEmployeeInterviewWithDetails.DatabaseResult, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.AssignedEmployeeInterviewWithDetails.DatabaseResult"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Education.CreateEmployeeEducationCommand.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.Education.CreateEmployeeEducationCommand.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.Education.EmployeeEducationQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.Education.EmployeeEducationQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeACHHistoryListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeACHHistoryListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeAdjustmentHistoryListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeAdjustmentHistoryListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeAvailabilityListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeAvailabilityListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeCandidaciesQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeCandidaciesQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeCandidacySummary.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeCandidacySummary.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeInterestCodeListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeInterestCodeListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeOffersQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeOffersQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeePayCardHistoryListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeePayCardHistoryListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeePayTransparencyListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeePayTransparencyListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeePaycheckListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeePaycheckListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeRequiredDocumentList.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeRequiredDocumentList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeTaxList.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeTaxList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeTaxesToDateHistoryListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeTaxesToDateHistoryListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeTransactionHistoryListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeTransactionHistoryListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.EmployeeWebAnnouncementListQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeWebAnnouncementListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.References.EmployeeReferenceQuestionsQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.References.EmployeeReferenceQuestionsQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.References.EmployeeReferencesQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.References.EmployeeReferencesQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Employees.Service.Commands.WorkHistory.EmployeeWorkHistoriesQuery.Result, Employees.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.WorkHistory.EmployeeWorkHistoriesQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Commands.BackgroundCheckVendorCustomDataFields.Result, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Commands.BackgroundCheckVendorCustomDataFields.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Commands.Packages.PackageResult, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Commands.Packages.PackageResult"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Commands.Screenings.ScreeningResult, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Commands.Screenings.ScreeningResult"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Common.BackgroundCheckVendors.Result, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Common.BackgroundCheckVendors.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow.OpenCase, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow.OpenCase"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.CasesSearchResultItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CasesSearchResultItem"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.HrCenterSearchQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.HrCenter.Service.Commands.HrCenterSearchQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.ProductInstanceLanguageListQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.HrCenter.Service.Commands.ProductInstanceLanguageListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.ProductInstancePagesListQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.HrCenter.Service.Commands.ProductInstancePagesListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.ProductInstanceStepsListQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.HrCenter.Service.Commands.ProductInstanceStepsListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.ProductInstanceWorkflowListQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.HrCenter.Service.Commands.ProductInstanceWorkflowListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.ProductInstanceWorkflowStepPagesListQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.HrCenter.Service.Commands.ProductInstanceWorkflowStepPagesListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.HrCenter.Service.Commands.StepStatusListQuery.Result, HrCenter.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.HrCenter.Service.Commands.StepStatusListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.Adjustments.JobOrderAdjustments.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.Adjustments.JobOrderAdjustments.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.AssignmentRestriction.AssignmentRestrictionSessionResultsQuery.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.AssignmentRestriction.AssignmentRestrictionSessionResultsQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.InterestCodes.JobOrderInterestCodesQuery.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.InterestCodes.JobOrderInterestCodesQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.JobOrderCandidatesQuery.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderCandidatesQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.JobOrderCandidatesSummary.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderCandidatesSummary.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.JobOrderContactsQuery.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderContactsQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.JobOrderRequiredDocumentTypes.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.JobOrderRequiredDocumentTypes.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.MassUpdateFinancials.MassUpdateJobOrderFinancialsMultiplierCodes.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.MassUpdateFinancials.MassUpdateJobOrderFinancialsMultiplierCodes.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.MassUpdateFinancials.MassUpdateJobOrderFinancialsResults.CalculationResult, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.MassUpdateFinancials.MassUpdateJobOrderFinancialsResults.CalculationResult"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.MultipleJobOrdersCandidatesQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.MultipleJobOrdersCandidatesQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.JobOrders.Service.Commands.Vendors.JobOrderVendorsList.Result, JobOrders.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.Vendors.JobOrderVendorsList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetDocumentsToSignForStepQuery.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetDocumentsToSignForStepQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetPageInstanceQuestionListQuery.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetPageInstanceQuestionListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetSecondaryWorkflowInstancesList.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetSecondaryWorkflowInstancesList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetStepInstancePageInstanceListQuery.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetStepInstancePageInstanceListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetWorkflowInstanceListQuery.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetWorkflowInstanceListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Onboarding.Service.Commands.GetWorkflowInstanceStepList.Result, Onboarding.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.Service.Commands.GetWorkflowInstanceStepList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Datalists.EmployeeWebTimecardAdjustmentsForAssignment.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Datalists.EmployeeWebTimecardAdjustmentsForAssignment.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Datalists.InvoiceHoldCodeList.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Datalists.InvoiceHoldCodeList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Datalists.PayHoldCodeList.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Datalists.PayHoldCodeList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Datalists.WebTimecardCostCentersForAssignment.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Datalists.WebTimecardCostCentersForAssignment.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Datalists.WebTimecardPaycodesForAssignment.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Datalists.WebTimecardPaycodesForAssignment.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Datalists.WebTimecardStatusList.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Datalists.WebTimecardStatusList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.PaycardChecks.PaycardChecksQuery.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.PaycardChecks.PaycardChecksQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.PaycardFundingRuns.PaycardFundingRunMembersQuery.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.PaycardFundingRuns.PaycardFundingRunMembersQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.PaycardFundingRuns.PaycardFundingRunValidateMembersQuery.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.PaycardFundingRuns.PaycardFundingRunValidateMembersQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.PaycardFundingRuns.PaycardFundingRunsQuery.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.PaycardFundingRuns.PaycardFundingRunsQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Paychecks.PaycheckAccrualsListQuery.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Paychecks.PaycheckAccrualsListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Paychecks.PaycheckAdjustmentsListQuery.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Paychecks.PaycheckAdjustmentsListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Paychecks.PaycheckAllowancesListQuery.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Paychecks.PaycheckAllowancesListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Paychecks.PaycheckTaxesListQuery.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Paychecks.PaycheckTaxesListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Paychecks.PaycheckTransactionsListQuery.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Paychecks.PaycheckTransactionsListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Proofing.GetIncompleteTimecards.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Proofing.GetIncompleteTimecards.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Proofing.GetNonBillableTimecards.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Proofing.GetNonBillableTimecards.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Proofing.GetNonPayableTimecards.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Proofing.GetNonPayableTimecards.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Proofing.GetTimecardProofingErrors.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Proofing.GetTimecardProofingErrors.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Proofing.GetTimecardProofingSessions.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Proofing.GetTimecardProofingSessions.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Proofing.GetTimecardsByProofingSessionWithFilters.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Proofing.GetTimecardsByProofingSessionWithFilters.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.TimeEntry.GetAdjustmentsForTimecards.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetAdjustmentsForTimecards.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardAdjustments.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardAdjustments.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardAssignmentAdjustments.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardAssignmentAdjustments.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecards.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecards.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardAdjustmentsList.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardAdjustmentsList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardDocumentsList.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardDocumentsList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardListGroupedByAssignmentAndWeekend.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardListGroupedByAssignmentAndWeekend.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardsList.WebTimecardSummaryResponse, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardsList.WebTimecardSummaryResponse"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Prospects.Service.Commands.ProspectContactList.Result, Prospects.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Prospects.Service.Commands.ProspectContactList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.RateSheets.Service.Commands.GetRateSheetList.Result, RateSheets.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.RateSheets.Service.Commands.GetRateSheetList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.RateSheets.Service.Commands.GetRateSheetMatchList.Result, RateSheets.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.RateSheets.Service.Commands.GetRateSheetMatchList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Reports.Service.Commands.KpiReportParameters.Result, Reports.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Reports.Service.Commands.KpiReportParameters.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Reports.Service.Commands.KpiReports.Result, Reports.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Reports.Service.Commands.KpiReports.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Reports.Service.Commands.ReportsQuery.Result, Reports.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Reports.Service.Commands.ReportsQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.ContactsSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.ContactsSearchQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.ContractsSearch.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.ContractsSearch.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.CustomersSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.CustomersSearchQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SavedSearches.SavedSearchListQuery.SavedSearch, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.Dynamic.SavedSearches.SavedSearchListQuery.SavedSearch"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SavedSearches.SavedSearchTeamList.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.Dynamic.SavedSearches.SavedSearchTeamList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SearchCategoriesQuery.SearchCategory, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.Dynamic.SearchCategoriesQuery.SearchCategory"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SearchColumnTypeListQuery.SearchColumnType, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.Dynamic.SearchColumnTypeListQuery.SearchColumnType"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SearchDatalistQuery.DatalistItem, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.Dynamic.SearchDatalistQuery.DatalistItem"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.Dynamic.SearchHistoryListQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.Dynamic.SearchHistoryListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.EmailSearch.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.EmailSearch.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.EmployeesSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.EmployeesSearchQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.EverifyCasesSearchQuery.Response, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.EverifyCasesSearchQuery.Response"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.EverifySearchEligibilityStatementDatalistQuery.Response, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.EverifySearchEligibilityStatementDatalistQuery.Response"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.JobBoardSearch.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.JobBoardSearch.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.JobFeedGetJobs.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.JobFeedGetJobs.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.JobOrdersSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.JobOrdersSearchQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.JobsSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.JobsSearchQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.ProspectSearch.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.ProspectSearch.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.VendorsSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.VendorsSearchQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Commands.WebUsersSearchQuery.Result, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.WebUsersSearchQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Models.DynamicSearchColumn, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Models.DynamicSearchColumn"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Models.DynamicSearchOperator, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Models.DynamicSearchOperator"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Searches.Service.Models.EmployeeRequiredDocumentSearchResult, Searches.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Models.EmployeeRequiredDocumentSearchResult"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Staging.Service.Employee.Commands.StagedEmployeeDuplicatesQuery.Result, Staging.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Commands.StagedEmployeeDuplicatesQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeContactMethod, Staging.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeContactMethod"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeEducation, Staging.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeEducation"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeInterestCode, Staging.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeInterestCode"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeWithStatus, Staging.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeWithStatus"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeWorkExperience, Staging.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeWorkExperience"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomContent.CardsByHier.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.CustomContent.CardsByHier.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomContent.CardsInPage.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.CustomContent.CardsInPage.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomContent.ContentRouteList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.CustomContent.ContentRouteList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomContent.EligibleCardsForPage.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.CustomContent.EligibleCardsForPage.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomContent.PageList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.CustomContent.PageList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomContent.PagesWithCardsByHier.PageBasicInfo, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.CustomContent.PagesWithCardsByHier.PageBasicInfo"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.CustomData.PropertyPermissionsQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.CustomData.PropertyPermissionsQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.DataExport.DataExportCategoryList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.DataExport.DataExportCategoryList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.DataExport.DataExportList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.DataExport.DataExportList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.DataExport.DataExportParameterList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.DataExport.DataExportParameterList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.EmailAccounts.EmailAccountsList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.EmailAccounts.EmailAccountsList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.EmailAccounts.EmailSignaturesList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.EmailAccounts.EmailSignaturesList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.GetContactHotlistMembers.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.Hotlists.GetContactHotlistMembers.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.GetCustomerHotlistMembers.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.Hotlists.GetCustomerHotlistMembers.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.GetEmployeeHotlistMembers.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.Hotlists.GetEmployeeHotlistMembers.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.GetHotlistMembership.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.Hotlists.GetHotlistMembership.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.GetHotlists.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.Hotlists.GetHotlists.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.GetHotlistsByOriginType.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.Hotlists.GetHotlistsByOriginType.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.HotlistAvailableServiceReps.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.Hotlists.HotlistAvailableServiceReps.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Hotlists.HotlistAvailableTeams.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.Hotlists.HotlistAvailableTeams.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.MessageAggregateQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.MessageAggregateQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.ProductInstances.ProductInstanceConfigurationsQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.ProductInstances.ProductInstanceConfigurationsQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupCustomerStatusListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupCustomerStatusListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupDataExportAvailableListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupDataExportAvailableListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupDataExportListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupDataExportListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupDocumentTypeListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupDocumentTypeListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupKpiReport.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupKpiReport.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupMessageActionTypeListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupMessageActionTypeListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupPermissionsListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupPermissionsListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupReportGroupQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupReportGroupQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupReportQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupReportQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupRolesListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupRolesListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupUsersListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupUsersListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.ServiceRepTeams.ServiceRepTeamSavedSearchesQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.ServiceRepTeams.ServiceRepTeamSavedSearchesQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Users.UserBookmarksQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.Users.UserBookmarksQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Users.UserLocalizationSettingsQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.Users.UserLocalizationSettingsQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Users.UserPermissionsListQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.Users.UserPermissionsListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Users.UserSecurityGroupsQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.Users.UserSecurityGroupsQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Commands.Users.UserSelectableHierTypeQuery.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.Users.UserSelectableHierTypeQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Models.Card, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Models.Card"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.System.Service.Models.CardSummary, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Models.CardSummary"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Timeclock.Service.Commands.TimeclockPhoneAssignmentsSummariesQuery.Result, Timeclock.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Timeclock.Service.Commands.TimeclockPhoneAssignmentsSummariesQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Vendors.Service.Commands.VendorContactsQuery.Result, Vendors.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Vendors.Service.Commands.VendorContactsQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.YearEnd.Service.Commands.YearEndEmployeeTaxForms.Result, YearEnd.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.YearEnd.Service.Commands.YearEndEmployeeTaxForms.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.YearEnd.Service.Commands.YearEndTaxFormTypes.Result, YearEnd.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.YearEnd.Service.Commands.YearEndTaxFormTypes.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.CustomData.EntityCustomDataQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.CustomData.EntityCustomDataQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.CustomData.EntityCustomDataSearch.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.CustomData.EntityCustomDataSearch.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.AdjustmentsListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.AdjustmentsListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.AvailableKpiReportList.Result, System.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.AvailableKpiReportList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.BranchListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.BranchListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.BurdenTypeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.BurdenTypeListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.BusinessCodeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.BusinessCodeListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.CompanyListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.CompanyListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ContactMethodTypeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.ContactMethodTypeListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.CountryCallingCodeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.CountryCallingCodeListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.CountryListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.CountryListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.CountyTaxJurisdictionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.CountyTaxJurisdictionListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.CustomDataDatalistQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.CustomDataDatalistQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.CustomerStatusListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.CustomerStatusListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.DistanceUnitList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.DistanceUnitList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.DivisionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.DivisionListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.EEOClassListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.EEOClassListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.EmployeeStatusListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.EmployeeStatusListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.EmployerListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.EmployerListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.EmploymentCategoryListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.EmploymentCategoryListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ExternalServiceEncryptionTypeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.ExternalServiceEncryptionTypeListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ExternalServiceVisibilityMethodsListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.ExternalServiceVisibilityMethodsListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ExternalServicesListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.ExternalServicesListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.FrequencyListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.FrequencyListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.GenderListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.GenderListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.GetAvailableEmployerPortionAdjustments.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.GetAvailableEmployerPortionAdjustments.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.GetDocumentTypesQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.GetDocumentTypesQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.GetRequiredDocumentCategories.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.GetRequiredDocumentCategories.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.GetRequiredDocumentStatus.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.GetRequiredDocumentStatus.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.HierListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.HierListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.HowHeardOfListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.HowHeardOfListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.InterestCodeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.InterestCodeListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.InterestCodeSubCategoryList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.InterestCodeSubCategoryList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.InvoicingMethodListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.InvoicingMethodListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.JobOrderCompanyStatusList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.JobOrderCompanyStatusList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.JobTitleListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.JobTitleListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.MessageActionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.MessageActionListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.MessageActionTypeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.MessageActionTypeListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.MultiplierCodeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.MultiplierCodeListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.MunicipalityTaxJurisdictionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.MunicipalityTaxJurisdictionListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.NamePrefixListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.NamePrefixListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.NationalityListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.NationalityListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.NotificationTypesListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.NotificationTypesListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.OrderTypeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.OrderTypeListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.OvertimeFactorListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.OvertimeFactorListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.OvertimePlanListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.OvertimePlanListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ParentTaxJurisdictionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.ParentTaxJurisdictionListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.PayPeriodDataListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.PayPeriodDataListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.PaycardVendorsListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.PaycardVendorsListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.PaymentTermsListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.PaymentTermsListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.PennsylvaniaLocalServiceTaxListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.PennsylvaniaLocalServiceTaxListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.PennsylvaniaPsdCodesListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.PennsylvaniaPsdCodesListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.PermissionsListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.PermissionsListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ProductInstanceListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.ProductInstanceListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ProductList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.ProductList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ProofingErrorTypeSeverities.ProofingErrorTypeSeverities.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.ProofingErrorTypeSeverities.ProofingErrorTypeSeverities.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.RegionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.RegionListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.RegionTaxJurisdictionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.RegionTaxJurisdictionListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ReportGroupListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.ReportGroupListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.RequiredDocumentAuthorityList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.RequiredDocumentAuthorityList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.RequiredDocumentTypeList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.RequiredDocumentTypeList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.SalesTeamListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.SalesTeamListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.SchoolDistrictTaxJurisdictionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.SchoolDistrictTaxJurisdictionListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.SecurityGroupTypeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.SecurityGroupTypeListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ServiceRepListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.ServiceRepListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.ServiceRepsByPermission.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.ServiceRepsByPermission.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.SkillCodeCategoryListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.SkillCodeCategoryListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.SocCodesList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.SocCodesList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.TaxJurisdictionListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.TaxJurisdictionListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.TaxJurisdictionLocationListQuery.Result, Datalists.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.TaxJurisdictionLocationListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.VeteranStatusListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.VeteranStatusListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.WashedStatusListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.WashedStatusListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.WeekdaysListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.WeekdaysListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.WeekendBillList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.WeekendBillList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.WeekendDateList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.WeekendDateList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.WorkerCompCodeListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.WorkerCompCodeListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Datalists.WotcEligibilityStatusList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Datalists.WotcEligibilityStatusList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Documents.GetEntityDocumentsQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Documents.GetEntityDocumentsQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Tasks.TaskListQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Tasks.TaskListQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Timeclock.CustomerTimeclockCostCodeList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Timeclock.CustomerTimeclockCostCodeList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Timeclock.CustomerTimeclockPayCodeList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Timeclock.CustomerTimeclockPayCodeList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Timeclock.PunchLocationList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Timeclock.PunchLocationList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.Users.UserCachedPermissionsQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Users.UserCachedPermissionsQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.GetWebUserDocuments.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.GetWebUserDocuments.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.WebCenterRoleList.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.WebCenterRoleList.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.WebUserAccountProductInstanceListByOriginPairQuery.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.WebUserAccountProductInstanceListByOriginPairQuery.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Shared.Commands.WebUserAccounts.WebUserAvailableProductInstances.Result, TwAPI.Shared.Commands, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.WebUserAvailableProductInstances.Result"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Infrastructure.PagedList`1[[TwApi.Vendors.Service.Commands.Sovren.Models.SovrenUserJobBoardDetail, Vendors.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sovren.Models.SovrenUserJobBoardDetail"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Models.ApiUser": {
"type": "object",
"properties": {
"srIdent": {
"type": "integer",
"format": "int32"
},
"serviceRepGUID": {
"type": "string",
"format": "uuid",
"nullable": true
},
"repName": {
"type": "string",
"nullable": true
},
"tenantName": {
"type": "string",
"nullable": true
},
"organizationName": {
"type": "string",
"nullable": true
},
"userName": {
"type": "string",
"nullable": true
},
"clientId": {
"type": "string",
"nullable": true
},
"productInstanceId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"webUserOriginTypeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"webUserOriginId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"isAuthenticatedAsWebUser": {
"type": "boolean",
"readOnly": true
},
"tokenType": {
"type": "string",
"nullable": true
},
"userType": {
"type": "string",
"nullable": true
},
"isOrganizationAdministrator": {
"type": "boolean"
},
"externalIdentityProviderId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"twRoleId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"tenantGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"correlationId": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Common.Models.AssignmentRestrictions.EmployeeCustomerDoNotAssign": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"doNotAssignGuid": {
"type": "string",
"format": "uuid"
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"employeeFirstName": {
"type": "string",
"nullable": true
},
"employeeLastName": {
"type": "string",
"nullable": true
},
"customerId": {
"type": "integer",
"format": "int64"
},
"customerName": {
"type": "string",
"nullable": true
},
"departmentName": {
"type": "string",
"nullable": true
},
"isInitiatedByEmployee": {
"type": "boolean"
},
"isInitiatedByCustomer": {
"type": "boolean"
},
"isForAllDepartments": {
"type": "boolean"
},
"messageId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"message": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Common.Models.ContactMessages.CreateContactMessageResult": {
"type": "object",
"properties": {
"messageId": {
"type": "integer",
"format": "int64"
},
"contactMessageRootGuid": {
"type": "string",
"format": "uuid"
},
"failedToBeLinkedOrigins": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.FailedOrigin"
},
"nullable": true
},
"failedToBeLinkedDocuments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.FailedDocument"
},
"nullable": true
},
"numberOfSuccessfullyLinkedOrigins": {
"type": "integer",
"format": "int32"
},
"successfullyLinkedOrigins": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.Origin"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Common.Models.ContactMessages.FailedDocument": {
"type": "object",
"properties": {
"errorMessages": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"documentId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Models.ContactMessages.FailedOrigin": {
"type": "object",
"properties": {
"errorMessage": {
"type": "string",
"nullable": true
},
"originTypeId": {
"type": "integer",
"format": "int32"
},
"originId": {
"type": "integer",
"format": "int64"
}
},
"additionalProperties": false
},
"TwApi.Common.Models.ContactMessages.UpdateContactMessageResult": {
"type": "object",
"properties": {
"messageId": {
"type": "integer",
"format": "int64"
},
"contactMessageRootGuid": {
"type": "string",
"format": "uuid"
},
"failedToBeLinkedOrigins": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.FailedOrigin"
},
"nullable": true
},
"failedToBeLinkedDocuments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.ContactMessages.FailedDocument"
},
"nullable": true
},
"numberOfSuccessfullyLinkedOrigins": {
"type": "integer",
"format": "int32"
},
"successfullyLinkedOrigins": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.Origin"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Common.Models.ContactMethods.EntityContactMethod": {
"type": "object",
"properties": {
"contactMethodId": {
"type": "integer",
"format": "int32"
},
"contactMethodGroupTypeId": {
"type": "integer",
"format": "int32"
},
"contactMethodTypeId": {
"type": "integer",
"format": "int32"
},
"contactMethodType": {
"type": "string",
"nullable": true
},
"contactMethod": {
"type": "string",
"nullable": true
},
"notes": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"dateCreated": {
"type": "string",
"format": "date-time"
},
"providerId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"countryCallingCode": {
"type": "integer",
"format": "int32",
"nullable": true
},
"isPinned": {
"type": "boolean"
},
"contactMethodGuid": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"TwApi.Common.Models.ContactMethods.SendTextMessageToContactMethodRequest": {
"type": "object",
"properties": {
"contactMethodId": {
"type": "integer",
"format": "int32"
},
"originTypeId": {
"type": "integer",
"format": "int32"
},
"originId": {
"type": "integer",
"format": "int64"
},
"externalServiceId": {
"type": "integer",
"format": "int64"
}
},
"additionalProperties": false
},
"TwApi.Common.Models.Documents.DocumentDetails": {
"type": "object",
"properties": {
"documentId": {
"type": "integer",
"format": "int32"
},
"documentName": {
"type": "string",
"nullable": true
},
"documentType": {
"type": "string",
"nullable": true
},
"documentTypeId": {
"type": "integer",
"format": "int32"
},
"documentDate": {
"type": "string",
"format": "date-time"
},
"description": {
"type": "string",
"nullable": true
},
"fileName": {
"type": "string",
"nullable": true
},
"fileType": {
"type": "string",
"nullable": true
},
"fileSize": {
"type": "integer",
"format": "int64",
"nullable": true
},
"canBeEdited": {
"type": "boolean"
},
"canBeDeleted": {
"type": "boolean"
},
"ownerOriginId": {
"type": "integer",
"format": "int64"
},
"ownerOriginTypeId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Models.ExternalServices.EmailOAuthCredentials": {
"type": "object",
"properties": {
"authorizeUrl": {
"type": "string",
"nullable": true
},
"accessToken": {
"type": "string",
"nullable": true
},
"refreshToken": {
"type": "string",
"nullable": true
},
"dateAccessTokenExpires": {
"type": "string",
"format": "date-time"
},
"userInteractionRequired": {
"type": "boolean"
},
"userEmailAddress": {
"type": "string",
"nullable": true
},
"userDisplayName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Common.Models.ExternalServices.PossiblyCensoredEmailBasicAuthCredentials": {
"type": "object",
"properties": {
"hasPassword": {
"type": "boolean"
},
"host": {
"type": "string",
"nullable": true
},
"port": {
"type": "integer",
"format": "int32"
},
"username": {
"type": "string",
"nullable": true
},
"password": {
"type": "string",
"nullable": true
},
"encryptionMethodId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Models.ExternalServices.SovrenJobBoard": {
"type": "object",
"properties": {
"jobBoardName": {
"type": "string",
"nullable": true
},
"username": {
"type": "string",
"nullable": true
},
"password": {
"type": "string",
"nullable": true
},
"companyId": {
"type": "string",
"nullable": true
},
"apiKey": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"statusId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Models.InvoiceRecipient": {
"type": "object",
"properties": {
"recipientTypeId": {
"type": "integer",
"format": "int32"
},
"recipientType": {
"type": "string",
"nullable": true
},
"contactId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"contactLastName": {
"type": "string",
"nullable": true
},
"contactFirstName": {
"type": "string",
"nullable": true
},
"contactTitle": {
"type": "string",
"nullable": true
},
"limitToOneInvoicePerEmail": {
"type": "boolean"
},
"emailContactMethodId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"emailAddress": {
"type": "string",
"nullable": true
},
"attachPdf": {
"type": "boolean"
},
"attachXls": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Common.Models.InvoiceRecipientForEdit": {
"type": "object",
"properties": {
"recipientTypeId": {
"type": "integer",
"format": "int32"
},
"contactId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"limitToOneInvoicePerEmail": {
"type": "boolean"
},
"emailContactMethodId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"attachPdf": {
"type": "boolean"
},
"attachXls": {
"type": "boolean"
},
"emailAddress": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Common.Models.Link": {
"type": "object",
"properties": {
"rel": {
"type": "string",
"nullable": true
},
"href": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Common.Models.LinksResponse": {
"type": "object",
"properties": {
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.Link"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Common.Models.LocalizedJobOrderDetails": {
"type": "object",
"properties": {
"locale": {
"type": "string",
"nullable": true
},
"publicJobTitle": {
"type": "string",
"nullable": true
},
"publicJobDescription": {
"type": "string",
"nullable": true
},
"jobDescription": {
"type": "string",
"nullable": true
},
"dressCode": {
"type": "string",
"nullable": true
},
"safetyNotes": {
"type": "string",
"nullable": true
},
"directions": {
"type": "string",
"nullable": true
},
"shiftNotes": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Common.Models.LocalizedPublicJobDescription": {
"type": "object",
"properties": {
"locale": {
"type": "string",
"nullable": true
},
"publicJobTitle": {
"type": "string",
"nullable": true
},
"publicJobDescription": {
"maxLength": 8000,
"minLength": 0,
"type": "string",
"nullable": true
},
"jobDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Common.Models.Messages.MessageDetails": {
"type": "object",
"properties": {
"attachedDocuments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.Documents.DocumentDetails"
},
"nullable": true
},
"id": {
"type": "integer",
"format": "int64"
},
"contactMessageRootGuid": {
"type": "string",
"format": "uuid"
},
"message": {
"type": "string",
"nullable": true
},
"date": {
"type": "string",
"format": "date-time"
},
"actionId": {
"type": "integer",
"format": "int32"
},
"action": {
"type": "string",
"nullable": true
},
"actionDescription": {
"type": "string",
"nullable": true
},
"taskId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"authorSrIdent": {
"type": "integer",
"format": "int32"
},
"author": {
"type": "string",
"nullable": true
},
"linkedDocumentsCount": {
"type": "integer",
"format": "int32"
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageLink"
},
"nullable": true
},
"primaryOriginTypeId": {
"$ref": "#/components/schemas/TwApi.Common.Enums.OriginType"
},
"primaryOriginId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"messageLinkedDocuments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageLinkedDocument"
},
"nullable": true
},
"viaIntegrationName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Common.Models.Messages.MessageLink": {
"type": "object",
"properties": {
"originType": {
"$ref": "#/components/schemas/TwApi.Common.Enums.OriginType"
},
"originId": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string",
"nullable": true
},
"entity": {
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Common.Models.Messages.MessageLinkedDocument": {
"type": "object",
"properties": {
"documentId": {
"type": "integer",
"format": "int32"
},
"documentName": {
"type": "string",
"nullable": true
},
"ownerOriginId": {
"type": "integer",
"format": "int64"
},
"ownerOriginTypeId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Models.Messages.MessageSummary": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"contactMessageRootGuid": {
"type": "string",
"format": "uuid"
},
"message": {
"type": "string",
"nullable": true
},
"date": {
"type": "string",
"format": "date-time"
},
"actionId": {
"type": "integer",
"format": "int32"
},
"action": {
"type": "string",
"nullable": true
},
"actionDescription": {
"type": "string",
"nullable": true
},
"taskId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"authorSrIdent": {
"type": "integer",
"format": "int32"
},
"author": {
"type": "string",
"nullable": true
},
"linkedDocumentsCount": {
"type": "integer",
"format": "int32"
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageLink"
},
"nullable": true
},
"primaryOriginTypeId": {
"$ref": "#/components/schemas/TwApi.Common.Enums.OriginType"
},
"primaryOriginId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"messageLinkedDocuments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageLinkedDocument"
},
"nullable": true
},
"viaIntegrationName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Common.Models.OrderByColumn": {
"type": "object",
"properties": {
"orderBy": {
"type": "string",
"nullable": true
},
"orderByAscending": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Common.Models.Origin": {
"type": "object",
"properties": {
"originTypeId": {
"type": "integer",
"format": "int32"
},
"originId": {
"type": "integer",
"format": "int64"
}
},
"additionalProperties": false
},
"TwApi.Common.Models.OriginRequestModel": {
"required": [
"originId",
"originTypeId"
],
"type": "object",
"properties": {
"originTypeId": {
"type": "integer",
"format": "int32"
},
"originId": {
"type": "integer",
"format": "int64"
}
},
"additionalProperties": false
},
"TwApi.Common.Models.Timeclock.TimeclockDetailsSettingsModel": {
"type": "object",
"properties": {
"timeclockProductType": {
"$ref": "#/components/schemas/TwApi.Common.Enums.TimeclockProductType"
},
"isTimeclockOrder": {
"type": "boolean"
},
"canBePunched": {
"type": "boolean"
},
"payCodeIsRequired": {
"type": "boolean"
},
"doPayCodesExist": {
"type": "boolean"
},
"costCodeIsRequired": {
"type": "boolean"
},
"doCostCodesExist": {
"type": "boolean"
},
"isPunchingEnabled": {
"type": "boolean"
},
"isGeofencingEnabled": {
"type": "boolean"
},
"isFaceVerificationEnabled": {
"type": "boolean"
},
"faceVerificationConfidenceThresholdPercentage": {
"type": "integer",
"format": "int32"
},
"customerId": {
"type": "integer",
"format": "int64"
}
},
"additionalProperties": false
},
"TwApi.Common.Shared.Models.BackgroundChecks.BackgroundCheckValidationResult": {
"type": "object",
"properties": {
"employeeId": {
"type": "integer",
"format": "int64"
},
"propertyName": {
"type": "string",
"nullable": true
},
"resourceLocation": {
"type": "string",
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Common.Shared.Models.BackgroundChecks.EmployeeProfile": {
"type": "object",
"properties": {
"employeeId": {
"type": "integer",
"format": "int64"
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"middleName": {
"type": "string",
"nullable": true
},
"aliases": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"contactMethods": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.BackgroundChecks.EmployeeProfile.ContactMethod"
},
"nullable": true
},
"dateOfBirth": {
"type": "string",
"format": "date-time",
"nullable": true
},
"genderId": {
"$ref": "#/components/schemas/TwApi.Common.Enums.GenderType"
},
"gender": {
"type": "string",
"nullable": true
},
"ssn": {
"type": "string",
"nullable": true
},
"primaryAddress": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.BackgroundChecks.EmployeeProfile.Address"
},
"otherAddresses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.BackgroundChecks.EmployeeProfile.Address"
},
"nullable": true
},
"employers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.BackgroundChecks.EmployeeProfile.WorkHistory"
},
"nullable": true
},
"education": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.BackgroundChecks.EmployeeProfile.EducationHistory"
},
"nullable": true
},
"references": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.BackgroundChecks.EmployeeProfile.Reference"
},
"nullable": true
},
"driversLicense": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.BackgroundChecks.EmployeeProfile.DriversLicenseDetails"
},
"consentForm": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.BackgroundChecks.EmployeeProfile.BackgroundCheckConsentForm"
},
"backgroundCheckIdentifiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.BackgroundChecks.EmployeeProfile.BackgroundCheckIdentifier"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Common.Shared.Models.BackgroundChecks.EmployeeProfile.Address": {
"type": "object",
"properties": {
"isTemporaryAddress": {
"type": "boolean"
},
"street1": {
"type": "string",
"nullable": true
},
"street2": {
"type": "string",
"nullable": true
},
"municipality": {
"type": "string",
"nullable": true
},
"region": {
"type": "string",
"nullable": true
},
"postalCode": {
"type": "string",
"nullable": true
},
"countryCode": {
"type": "integer",
"format": "int32",
"nullable": true
},
"country": {
"type": "string",
"nullable": true
},
"isAddressStandardized": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Common.Shared.Models.BackgroundChecks.EmployeeProfile.BackgroundCheckConsentForm": {
"type": "object",
"properties": {
"documentId": {
"type": "integer",
"format": "int32"
},
"fileName": {
"type": "string",
"nullable": true
},
"fileType": {
"type": "string",
"nullable": true
},
"expirationDate": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Common.Shared.Models.BackgroundChecks.EmployeeProfile.BackgroundCheckIdentifier": {
"type": "object",
"properties": {
"backgroundCheckVendorId": {
"type": "integer",
"format": "int32"
},
"propertyValue": {
"type": "string",
"nullable": true
},
"propertyName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Common.Shared.Models.BackgroundChecks.EmployeeProfile.ContactMethod": {
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.BackgroundChecks.EmployeeProfile.ContactMethod.ContactMethodType"
},
"value": {
"type": "string",
"nullable": true
},
"countryCallingCode": {
"type": "integer",
"format": "int32",
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"description": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Common.Shared.Models.BackgroundChecks.EmployeeProfile.ContactMethod.ContactMethodType": {
"enum": [
1,
2
],
"type": "integer",
"format": "int32"
},
"TwApi.Common.Shared.Models.BackgroundChecks.EmployeeProfile.DriversLicenseDetails": {
"type": "object",
"properties": {
"region": {
"type": "string",
"nullable": true
},
"expirationDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"licenseNumber": {
"type": "string",
"nullable": true
},
"class": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Common.Shared.Models.BackgroundChecks.EmployeeProfile.EducationHistory": {
"type": "object",
"properties": {
"educationId": {
"type": "integer",
"format": "int32"
},
"institutionAttended": {
"type": "string",
"nullable": true
},
"enrollmentStatus": {
"type": "string",
"nullable": true
},
"degreeAwarded": {
"type": "string",
"nullable": true
},
"degreeDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"major": {
"type": "string",
"nullable": true
},
"grade": {
"type": "number",
"format": "double",
"nullable": true
},
"dateAttendedStart": {
"type": "string",
"format": "date-time",
"nullable": true
},
"dateAttendedEnd": {
"type": "string",
"format": "date-time",
"nullable": true
},
"address": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.BackgroundChecks.EmployeeProfile.StandardizedAddress"
}
},
"additionalProperties": false
},
"TwApi.Common.Shared.Models.BackgroundChecks.EmployeeProfile.Reference": {
"type": "object",
"properties": {
"referenceId": {
"type": "integer",
"format": "int32"
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"phoneNumber": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"referenceType": {
"type": "string",
"nullable": true
},
"relationship": {
"type": "string",
"nullable": true
},
"companyName": {
"type": "string",
"nullable": true
},
"dateReferenceChecked": {
"type": "string",
"format": "date-time",
"nullable": true
},
"address": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.BackgroundChecks.EmployeeProfile.StandardizedAddress"
},
"isOkayToContact": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Common.Shared.Models.BackgroundChecks.EmployeeProfile.StandardizedAddress": {
"type": "object",
"properties": {
"street1": {
"type": "string",
"nullable": true
},
"street2": {
"type": "string",
"nullable": true
},
"municipality": {
"type": "string",
"nullable": true
},
"region": {
"type": "string",
"nullable": true
},
"postalCode": {
"type": "string",
"nullable": true
},
"countryCode": {
"type": "integer",
"format": "int32",
"nullable": true
},
"country": {
"type": "string",
"nullable": true
},
"isAddressStandardized": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Common.Shared.Models.BackgroundChecks.EmployeeProfile.WorkHistory": {
"type": "object",
"properties": {
"workHistoryId": {
"type": "integer",
"format": "int32"
},
"startDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"endDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"employer": {
"type": "string",
"nullable": true
},
"employerAddress": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.BackgroundChecks.EmployeeProfile.StandardizedAddress"
},
"phoneNumber": {
"type": "string",
"nullable": true
},
"supervisorEmail": {
"type": "string",
"nullable": true
},
"position": {
"type": "string",
"nullable": true
},
"pay": {
"type": "string",
"nullable": true
},
"duties": {
"type": "string",
"nullable": true
},
"supervisorFirstName": {
"type": "string",
"nullable": true
},
"supervisorLastName": {
"type": "string",
"nullable": true
},
"supervisorTitle": {
"type": "string",
"nullable": true
},
"reasonForLeaving": {
"type": "string",
"nullable": true
},
"isOkayToContact": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Common.Shared.Models.Configuration.ProductConfiguration": {
"type": "object",
"properties": {
"configurationTypeId": {
"type": "string",
"nullable": true
},
"configurationType": {
"type": "string",
"nullable": true
},
"configurationTypeDescription": {
"type": "string",
"nullable": true
},
"valueDataType": {
"type": "string",
"nullable": true
},
"value": {
"type": "string",
"nullable": true
},
"supportingValue": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Common.Shared.Models.ContactMessages.CreateMessageWithLinkedDocumentsRequest": {
"required": [
"actionId",
"message"
],
"type": "object",
"properties": {
"linkedDocumentIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"actionId": {
"type": "integer",
"format": "int32"
},
"message": {
"minLength": 1,
"type": "string"
},
"linkedEntities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.Origin"
},
"nullable": true
},
"shouldLinkOriginsOneByOne": {
"type": "boolean"
},
"shouldLinkRelatedEntities": {
"type": "boolean"
},
"authorServiceRepId": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Common.Shared.Models.ContactMessages.CreateSimpleMessageRequest": {
"required": [
"actionId",
"message"
],
"type": "object",
"properties": {
"actionId": {
"type": "integer",
"format": "int32"
},
"message": {
"minLength": 1,
"type": "string"
},
"linkedEntities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.Origin"
},
"nullable": true
},
"shouldLinkOriginsOneByOne": {
"type": "boolean"
},
"shouldLinkRelatedEntities": {
"type": "boolean"
},
"authorServiceRepId": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Common.Shared.Models.ContactMessages.UpdateMessageWithLinkedDocumentsRequest": {
"required": [
"actionId",
"message"
],
"type": "object",
"properties": {
"linkedDocumentIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
},
"actionId": {
"type": "integer",
"format": "int32"
},
"message": {
"minLength": 1,
"type": "string"
},
"linkedEntities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.Origin"
},
"nullable": true
},
"shouldLinkOriginsOneByOne": {
"type": "boolean"
},
"taskId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"TwApi.Common.Shared.Models.ContactMethods.CreateEntityContactMethodRequest": {
"required": [
"contactMethod",
"contactMethodTypeId",
"isActive"
],
"type": "object",
"properties": {
"contactMethodTypeId": {
"type": "integer",
"format": "int32"
},
"contactMethod": {
"maxLength": 255,
"minLength": 0,
"type": "string"
},
"notes": {
"maxLength": 100,
"minLength": 0,
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"providerId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"countryCallingCode": {
"type": "integer",
"format": "int32",
"nullable": true
},
"isPinned": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Common.Shared.Models.CustomData.UpdateEntityCustomDataRequest": {
"required": [
"propertyValues"
],
"type": "object",
"properties": {
"propertyValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.CustomData.UpdateEntityCustomDataRequest.EntityPropertyValue"
}
}
},
"additionalProperties": false
},
"TwApi.Common.Shared.Models.CustomData.UpdateEntityCustomDataRequest.EntityPropertyValue": {
"required": [
"propertyDefinitionId"
],
"type": "object",
"properties": {
"propertyDefinitionId": {
"type": "string",
"format": "uuid"
},
"propertyValue": {
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Common.Shared.Models.Documents.UpdateEntityDocumentDetailsRequest": {
"required": [
"description",
"documentTypeId"
],
"type": "object",
"properties": {
"documentName": {
"maxLength": 100,
"minLength": 0,
"type": "string",
"nullable": true
},
"documentTypeId": {
"type": "integer",
"format": "int32"
},
"expirationDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"description": {
"maxLength": 255,
"minLength": 0,
"type": "string"
}
},
"additionalProperties": false
},
"TwApi.Common.Shared.Models.Email.SmtpAutoDiscoverRequest": {
"required": [
"email",
"password"
],
"type": "object",
"properties": {
"email": {
"minLength": 1,
"type": "string"
},
"password": {
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"TwApi.Common.Shared.Models.Email.SmtpSettingsRequest": {
"required": [
"encryptionMethodId",
"host",
"port"
],
"type": "object",
"properties": {
"host": {
"minLength": 1,
"type": "string"
},
"port": {
"type": "integer",
"format": "int32"
},
"username": {
"type": "string",
"nullable": true
},
"password": {
"type": "string",
"nullable": true
},
"encryptionMethodId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Shared.Models.Email.UpdateSmtpSettingsRequest": {
"required": [
"encryptionMethodId",
"host",
"port"
],
"type": "object",
"properties": {
"updatePassword": {
"type": "boolean",
"nullable": true
},
"host": {
"minLength": 1,
"type": "string"
},
"port": {
"type": "integer",
"format": "int32"
},
"username": {
"type": "string",
"nullable": true
},
"password": {
"type": "string",
"nullable": true
},
"encryptionMethodId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Shared.Models.StatusChange.AdditionalActionMessage": {
"type": "object",
"properties": {
"additionalActionId": {
"type": "integer",
"format": "int64"
},
"additionalActionName": {
"type": "string",
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Common.Shared.Models.StatusChange.StatusChangeApiRequest": {
"required": [
"createMessage",
"createTask",
"statusId"
],
"type": "object",
"properties": {
"statusId": {
"minLength": 1,
"type": "string"
},
"createMessage": {
"type": "boolean"
},
"message": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.StatusChange.StatusChangeApiRequest.CreateMessageRequest"
},
"createTask": {
"type": "boolean"
},
"task": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.StatusChange.StatusChangeApiRequest.CreateTaskRequest"
},
"additionalActions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.StatusChange.StatusChangeApiRequest.AdditionalAction"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Common.Shared.Models.StatusChange.StatusChangeApiRequest.AdditionalAction": {
"required": [
"additionalActionId",
"executeAction"
],
"type": "object",
"properties": {
"additionalActionId": {
"type": "integer",
"format": "int64"
},
"executeAction": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Common.Shared.Models.StatusChange.StatusChangeApiRequest.CreateMessageRequest": {
"required": [
"actionId"
],
"type": "object",
"properties": {
"message": {
"type": "string",
"nullable": true
},
"actionId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Shared.Models.StatusChange.StatusChangeApiRequest.CreateTaskRequest": {
"required": [
"isPrivate"
],
"type": "object",
"properties": {
"subject": {
"type": "string",
"nullable": true
},
"notes": {
"type": "string",
"nullable": true
},
"priority": {
"type": "integer",
"format": "int64",
"nullable": true
},
"dateDue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"assignedToServiceRepId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"teamId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"isPrivate": {
"type": "boolean"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Common.Shared.Models.Tasks.AssignTaskRequest": {
"required": [
"assignedToServiceRepId"
],
"type": "object",
"properties": {
"assignedToServiceRepId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Shared.Models.Tasks.CreateEntityTaskRequest": {
"required": [
"isPrivate",
"priority",
"subject"
],
"type": "object",
"properties": {
"subject": {
"maxLength": 255,
"minLength": 1,
"type": "string"
},
"notes": {
"type": "string",
"nullable": true
},
"priority": {
"type": "integer",
"format": "int64"
},
"dateDue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"assignedToServiceRepId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"teamId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"isPrivate": {
"type": "boolean"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Common.Shared.Models.Tasks.CreateTaskRequest": {
"required": [
"isPrivate",
"priority",
"subject"
],
"type": "object",
"properties": {
"linkedToOriginId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"linkedToOriginTypeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"subject": {
"maxLength": 255,
"minLength": 1,
"type": "string"
},
"notes": {
"type": "string",
"nullable": true
},
"priority": {
"type": "integer",
"format": "int64"
},
"dateDue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"assignedToServiceRepId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"teamId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"isPrivate": {
"type": "boolean"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Common.Shared.Models.Tasks.UpdateTaskRequest": {
"required": [
"isPrivate",
"priority",
"subject"
],
"type": "object",
"properties": {
"subject": {
"maxLength": 255,
"minLength": 1,
"type": "string"
},
"notes": {
"type": "string",
"nullable": true
},
"priority": {
"type": "integer",
"format": "int64"
},
"dateDue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"isPrivate": {
"type": "boolean"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Common.Shared.Models.Timeclock.CreatePunchLocationRequest": {
"required": [
"latitude",
"longitude",
"radius",
"radiusDistanceUnitId"
],
"type": "object",
"properties": {
"punchLocation": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"latitude": {
"maximum": 90,
"minimum": -90,
"type": "number",
"format": "double"
},
"longitude": {
"maximum": 180,
"minimum": -180,
"type": "number",
"format": "double"
},
"radius": {
"minimum": 0,
"type": "number",
"format": "double"
},
"radiusDistanceUnitId": {
"type": "integer",
"format": "int64"
}
},
"additionalProperties": false
},
"TwApi.Common.Shared.Models.Timeclock.UpdatePunchLocationRequest": {
"required": [
"latitude",
"longitude",
"radius",
"radiusDistanceUnitId"
],
"type": "object",
"properties": {
"punchLocation": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"latitude": {
"maximum": 90,
"minimum": -90,
"type": "number",
"format": "double"
},
"longitude": {
"maximum": 180,
"minimum": -180,
"type": "number",
"format": "double"
},
"radius": {
"minimum": 0,
"type": "number",
"format": "double"
},
"radiusDistanceUnitId": {
"type": "integer",
"format": "int64"
}
},
"additionalProperties": false
},
"TwApi.Common.Shared.Models.Utilities.CalculateGrossProfitRequest": {
"type": "object",
"properties": {
"workerCompCodeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"sutaJurisId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"additionalBurden": {
"type": "number",
"format": "double",
"nullable": true
},
"hoursPerWeek": {
"type": "number",
"format": "double",
"nullable": true
},
"numberOfWeeks": {
"type": "integer",
"format": "int32",
"nullable": true
},
"overtimePlanId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"useSuta": {
"type": "boolean",
"nullable": true
},
"useStateFuta": {
"type": "boolean",
"nullable": true
},
"useFuta": {
"type": "boolean",
"nullable": true
},
"useBranchBurden": {
"type": "boolean",
"nullable": true
},
"changedValue": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.ChangedValue"
},
"payRate": {
"type": "number",
"format": "double",
"nullable": true
},
"billRate": {
"type": "number",
"format": "double",
"nullable": true
},
"grossProfitPercent": {
"type": "number",
"format": "double",
"nullable": true
},
"grossProfitPercentBaseValue": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.GrossProfitBasedOnValue"
},
"overtimePayRate": {
"type": "number",
"format": "double",
"nullable": true
},
"overtimeBillRate": {
"type": "number",
"format": "double",
"nullable": true
},
"overtimeGrossProfitPercent": {
"type": "number",
"format": "double",
"nullable": true
},
"overtimeGrossProfitPercentBaseValue": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.GrossProfitBasedOnValue"
},
"doubletimePayRate": {
"type": "number",
"format": "double",
"nullable": true
},
"doubletimeBillRate": {
"type": "number",
"format": "double",
"nullable": true
},
"doubletimeGrossProfitPercent": {
"type": "number",
"format": "double",
"nullable": true
},
"doubletimeGrossProfitPercentBaseValue": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.GrossProfitBasedOnValue"
},
"expenses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.GrossProfitExpense"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Common.Shared.Models.Utilities.CalculateGrossProfitResult": {
"type": "object",
"properties": {
"workerCompCodeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"sutaJurisId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"additionalBurden": {
"type": "number",
"format": "double",
"nullable": true
},
"initialBurden": {
"type": "number",
"format": "double"
},
"totalBurden": {
"type": "number",
"format": "double"
},
"hoursPerWeek": {
"type": "number",
"format": "double",
"nullable": true
},
"numberOfWeeks": {
"type": "integer",
"format": "int32",
"nullable": true
},
"overtimePlanId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"useSuta": {
"type": "boolean",
"nullable": true
},
"useStateFuta": {
"type": "boolean",
"nullable": true
},
"useFuta": {
"type": "boolean",
"nullable": true
},
"useBranchBurden": {
"type": "boolean"
},
"branchBurden": {
"type": "number",
"format": "double",
"nullable": true
},
"payRate": {
"type": "number",
"format": "double",
"nullable": true
},
"billRate": {
"type": "number",
"format": "double",
"nullable": true
},
"grossProfitPercent": {
"type": "number",
"format": "double",
"nullable": true
},
"warningPercent": {
"type": "number",
"format": "double",
"nullable": true
},
"acceptedPercent": {
"type": "number",
"format": "double",
"nullable": true
},
"grossProfitAmount": {
"type": "number",
"format": "double",
"nullable": true
},
"markup": {
"type": "number",
"format": "double",
"nullable": true
},
"alertStatus": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.GrossProfitAlertStatus"
},
"overtimePayRate": {
"type": "number",
"format": "double",
"nullable": true
},
"overtimeBillRate": {
"type": "number",
"format": "double",
"nullable": true
},
"overtimeGrossProfitPercent": {
"type": "number",
"format": "double",
"nullable": true
},
"overtimeWarningPercent": {
"type": "number",
"format": "double",
"nullable": true
},
"overtimeAcceptedPercent": {
"type": "number",
"format": "double",
"nullable": true
},
"overtimeGrossProfitAmount": {
"type": "number",
"format": "double",
"nullable": true
},
"overtimeMarkup": {
"type": "number",
"format": "double",
"nullable": true
},
"overtimeAlertStatus": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.GrossProfitAlertStatus"
},
"doubletimePayRate": {
"type": "number",
"format": "double",
"nullable": true
},
"doubletimeBillRate": {
"type": "number",
"format": "double",
"nullable": true
},
"doubletimeGrossProfitPercent": {
"type": "number",
"format": "double",
"nullable": true
},
"doubletimeWarningPercent": {
"type": "number",
"format": "double",
"nullable": true
},
"doubletimeAcceptedPercent": {
"type": "number",
"format": "double",
"nullable": true
},
"doubletimeGrossProfitAmount": {
"type": "number",
"format": "double",
"nullable": true
},
"doubletimeMarkup": {
"type": "number",
"format": "double",
"nullable": true
},
"doubletimeAlertStatus": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Utilities.GrossProfitAlertStatus"
}
},
"additionalProperties": false
},
"TwApi.Common.Shared.Models.Utilities.ChangedValue": {
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9
],
"type": "integer",
"format": "int32"
},
"TwApi.Common.Shared.Models.Utilities.GrossProfitAlertStatus": {
"enum": [
0,
1,
2
],
"type": "integer",
"format": "int32"
},
"TwApi.Common.Shared.Models.Utilities.GrossProfitBasedOnValue": {
"enum": [
1,
2
],
"type": "integer",
"format": "int32"
},
"TwApi.Common.Shared.Models.Utilities.GrossProfitExpense": {
"type": "object",
"properties": {
"description": {
"type": "string",
"nullable": true
},
"amount": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"TwApi.Common.Shared.Models.WebUser.ChangeWebCenterRoleRequest": {
"required": [
"webCenterRoleId"
],
"type": "object",
"properties": {
"webCenterRoleId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"TwApi.Common.Shared.Models.WebUser.LinkToCompanionRequest": {
"required": [
"companionProductInstanceId"
],
"type": "object",
"properties": {
"companionProductInstanceId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"TwApi.Common.Shared.Models.WebUser.LinkToHrCenterRequest": {
"required": [
"hrCenterProductInstanceId"
],
"type": "object",
"properties": {
"hrCenterProductInstanceId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"TwApi.Common.Shared.Models.WebUser.LinkToJobBoardRequest": {
"required": [
"jobBoardProductInstanceId"
],
"type": "object",
"properties": {
"jobBoardProductInstanceId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"TwApi.Common.Shared.Models.WebUser.LinkToOpenAPICustomIntegrationRequest": {
"required": [
"openAPICustomIntegrationProductInstanceId"
],
"type": "object",
"properties": {
"openAPICustomIntegrationProductInstanceId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"TwApi.Common.Shared.Models.WebUser.LinkToTempWorksMobileAppRequest": {
"required": [
"tempWorksMobileAppProductInstanceId"
],
"type": "object",
"properties": {
"tempWorksMobileAppProductInstanceId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"TwApi.Common.Shared.Models.WebUser.LinkToWebCenterRequest": {
"required": [
"webCenterProductInstanceId",
"webCenterRoleId"
],
"type": "object",
"properties": {
"webCenterProductInstanceId": {
"type": "string",
"format": "uuid"
},
"webCenterRoleId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"TwApi.Common.Shared.Models.WebUser.RenameWebUserRequest": {
"required": [
"username"
],
"type": "object",
"properties": {
"username": {
"maxLength": 254,
"minLength": 0,
"type": "string"
}
},
"additionalProperties": false
},
"TwApi.Common.Shared.Models.WebUser.ResetWebUserPasswordRequest": {
"required": [
"temporaryPassword"
],
"type": "object",
"properties": {
"temporaryPassword": {
"maxLength": 100,
"minLength": 7,
"type": "string"
}
},
"additionalProperties": false
},
"TwApi.Common.Shared.Models.WebUser.UpdateWebUserPasswordRequest": {
"required": [
"newPassword",
"oldPassword",
"username"
],
"type": "object",
"properties": {
"username": {
"minLength": 1,
"type": "string"
},
"oldPassword": {
"minLength": 1,
"type": "string"
},
"newPassword": {
"maxLength": 100,
"minLength": 8,
"type": "string"
},
"requirePasswordReset": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Common.Shared.Models.WebUser.WebUserPasswordResetEmailRequest": {
"required": [
"product",
"productInstanceId",
"requestedByOriginId",
"requestedByOriginType",
"toEmailAddress"
],
"type": "object",
"properties": {
"productInstanceId": {
"type": "string",
"format": "uuid"
},
"product": {
"$ref": "#/components/schemas/TwApi.Common.Enums.Products"
},
"toEmailAddress": {
"minLength": 1,
"type": "string"
},
"requestedByOriginId": {
"type": "integer",
"format": "int64"
},
"requestedByOriginType": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Common.Shared.Models.WebUser.WebUserValidateCredentialsRequest": {
"required": [
"password",
"username"
],
"type": "object",
"properties": {
"username": {
"minLength": 1,
"type": "string"
},
"password": {
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"TwApi.Common.Validation.TwValidationEntry": {
"type": "object",
"properties": {
"messages": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"propertyName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.ExternalIntegrations.Adp.Service.Commands.ADPEnrollmentStatusQuery.Result": {
"type": "object",
"properties": {
"enrollmentStatus": {
"type": "string",
"nullable": true
},
"enrollmentId": {
"type": "string",
"nullable": true
},
"isEnrollmentComplete": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.ExternalIntegrations.Adp.Service.Commands.ADPOrganizationLocationListQuery.Location": {
"type": "object",
"properties": {
"locationId": {
"type": "string",
"nullable": true
},
"longName": {
"type": "string",
"nullable": true
},
"shortName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.ExternalIntegrations.Adp.Service.Commands.ADPPaycardFundingAccountsListQuery.FundingAccount": {
"type": "object",
"properties": {
"accountId": {
"type": "string",
"nullable": true
},
"accountIdSchemeCode": {
"type": "string",
"nullable": true
},
"accountNumber": {
"type": "string",
"nullable": true
},
"accountName": {
"type": "string",
"nullable": true
},
"locationId": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.ExternalIntegrations.Adp.Service.Commands.ADPValidatePaycardAccountCommand.Result": {
"type": "object",
"properties": {
"locationName": {
"type": "string",
"nullable": true
},
"locationId": {
"type": "string",
"nullable": true
},
"routingTransitId": {
"type": "string",
"nullable": true
},
"routingTransitSchemeCode": {
"type": "string",
"nullable": true
},
"accountNumber": {
"type": "string",
"nullable": true
},
"accountId": {
"type": "string",
"nullable": true
},
"accountSchemeCode": {
"type": "string",
"nullable": true
},
"accountStatusCode": {
"type": "string",
"nullable": true
},
"canBeIssued": {
"type": "boolean"
},
"cannotBeIssuedReason": {
"type": "string",
"nullable": true
},
"canBeFunded": {
"type": "boolean"
},
"cannotBeFundedReason": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.ExternalIntegrations.PowerBiCloud.Service.Commands.GetPowerBiWorkspaceDatasets.Result": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"webUrl": {
"type": "string",
"nullable": true
},
"contentProviderType": {
"type": "string",
"nullable": true
},
"createReportEmbedURL": {
"type": "string",
"nullable": true
},
"createdDate": {
"type": "string",
"nullable": true
},
"encryption": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.PowerBiCloud.Service.Models.Encryption"
},
"isEffectiveIdentityRequired": {
"type": "boolean"
},
"isEffectiveIdentityRolesRequired": {
"type": "boolean"
},
"isOnPremGatewayRequired": {
"type": "boolean"
},
"isRefreshable": {
"type": "boolean"
},
"qnaEmbedURL": {
"type": "string",
"nullable": true
},
"addRowsAPIEnabled": {
"type": "boolean"
},
"configuredBy": {
"type": "string",
"nullable": true
},
"targetStorageMode": {
"type": "string",
"nullable": true
},
"upstreamDataflows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.PowerBiCloud.Service.Models.DependentDataflow"
},
"nullable": true
},
"users": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.PowerBiCloud.Service.Models.DatasetUser"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.ExternalIntegrations.PowerBiCloud.Service.Commands.GetPowerBiWorkspaceReports.Result": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"workspaceId": {
"type": "string",
"format": "uuid"
},
"reportType": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"webUrl": {
"type": "string",
"nullable": true
},
"embedUrl": {
"type": "string",
"nullable": true
},
"isFromPbix": {
"type": "boolean"
},
"isOwnedByMe": {
"type": "boolean"
},
"datasetId": {
"type": "string",
"format": "uuid"
},
"datasetWorkspaceId": {
"type": "string",
"format": "uuid"
},
"users": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"subscriptions": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.ExternalIntegrations.PowerBiCloud.Service.Commands.GetPowerBiWorkspaces.Result": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"isReadOnly": {
"type": "boolean"
},
"isOnDedicatedCapacity": {
"type": "boolean"
},
"type": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.ExternalIntegrations.PowerBiCloud.Service.Models.DatasetUser": {
"type": "object",
"properties": {
"datasetUserAccessRight": {
"type": "string",
"nullable": true
},
"displayName": {
"type": "string",
"nullable": true
},
"emailAddress": {
"type": "string",
"nullable": true
},
"graphId": {
"type": "string",
"format": "uuid"
},
"identifier": {
"type": "string",
"nullable": true
},
"principalType": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.ExternalIntegrations.PowerBiCloud.Service.Models.DependentDataflow": {
"type": "object",
"properties": {
"groupId": {
"type": "string",
"format": "uuid"
},
"targetDataflowId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"TwApi.ExternalIntegrations.PowerBiCloud.Service.Models.Encryption": {
"type": "object",
"properties": {
"encryptionStatus": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.ExternalIntegrations.Sovren.Service.Models.Client": {
"type": "object",
"properties": {
"linkText": {
"type": "string",
"nullable": true
},
"isBulk": {
"type": "boolean"
},
"urlAction": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.Sovren.Service.Models.UrlAction"
},
"jsAction": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.Sovren.Service.Models.JsAction"
}
},
"additionalProperties": false
},
"TwApi.ExternalIntegrations.Sovren.Service.Models.Hooks": {
"type": "object",
"properties": {
"client": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.Sovren.Service.Models.Client"
},
"nullable": true
},
"server": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.Sovren.Service.Models.Server"
},
"nullable": true
},
"sourcing": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.Sovren.Service.Models.Sourcing"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.ExternalIntegrations.Sovren.Service.Models.JsAction": {
"type": "object",
"properties": {
"target": {
"type": "string",
"nullable": true
},
"targetOrigin": {
"type": "string",
"nullable": true
},
"data": {
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.ExternalIntegrations.Sovren.Service.Models.Server": {
"type": "object",
"properties": {
"linkText": {
"type": "string",
"nullable": true
},
"url": {
"type": "string",
"nullable": true
},
"customInfo": {
"nullable": true
},
"isBulk": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.ExternalIntegrations.Sovren.Service.Models.Sourcing": {
"type": "object",
"properties": {
"linkText": {
"type": "string",
"nullable": true
},
"url": {
"type": "string",
"nullable": true
},
"customInfo": {
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.ExternalIntegrations.Sovren.Service.Models.UrlAction": {
"type": "object",
"properties": {
"url": {
"type": "string",
"nullable": true
},
"target": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.ExternalIntegrations.ZipWhip.Service.Models.TWResponseData": {
"type": "object",
"properties": {
"recipient": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.ZipWhip.Service.Models.TextMessageRecipient"
},
"isTextMessageSent": {
"type": "boolean"
},
"isContactSaved": {
"type": "boolean"
},
"errorMessage": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.ExternalIntegrations.ZipWhip.Service.Models.TextMessageRecipient": {
"required": [
"originId",
"originTypeId",
"phoneNumber"
],
"type": "object",
"properties": {
"phoneNumber": {
"minLength": 1,
"type": "string"
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"originId": {
"type": "integer",
"format": "int64"
},
"originTypeId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Messages.Assignments.AssignmentJobDetails.Result": {
"type": "object",
"properties": {
"assignmentId": {
"type": "integer",
"format": "int64"
},
"assignmentRootGuid": {
"type": "string",
"format": "uuid"
},
"jobOrderId": {
"type": "integer",
"format": "int64"
},
"isScheduledForSunday": {
"type": "boolean"
},
"isScheduledForMonday": {
"type": "boolean"
},
"isScheduledForTuesday": {
"type": "boolean"
},
"isScheduledForWednesday": {
"type": "boolean"
},
"isScheduledForThursday": {
"type": "boolean"
},
"isScheduledForFriday": {
"type": "boolean"
},
"isScheduledForSaturday": {
"type": "boolean"
},
"jobTitleId": {
"type": "integer",
"format": "int32"
},
"jobTitle": {
"type": "string",
"nullable": true
},
"businessCodeId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"businessCode": {
"type": "string",
"nullable": true
},
"startDate": {
"type": "string",
"format": "date-time"
},
"originalStartDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"expectedEndDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"endDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"shiftId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"shift": {
"type": "string",
"nullable": true
},
"startTime": {
"type": "string",
"nullable": true
},
"endTime": {
"type": "string",
"nullable": true
},
"parsedEndTime": {
"type": "string",
"format": "date-span",
"nullable": true
},
"parsedStartTime": {
"type": "string",
"format": "date-span",
"nullable": true
},
"shiftNote": {
"type": "string",
"nullable": true
},
"worksiteId": {
"type": "integer",
"format": "int32"
},
"worksiteName": {
"type": "string",
"nullable": true
},
"worksiteAddress": {
"$ref": "#/components/schemas/TempWorks.TwApi.Common.Models.Address"
},
"remoteWorkStatusId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"remoteWorkStatus": {
"type": "string",
"nullable": true
},
"localizedAssignmentDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TempWorks.TwApi.Common.Models.LocalizedShiftValues"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Messages.Assignments.AssignmentSearch.Result": {
"type": "object",
"properties": {
"assignmentId": {
"type": "integer",
"format": "int64"
},
"lastName": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"middleName": {
"type": "string",
"nullable": true
},
"employeePrimaryEmailAddress": {
"type": "string",
"nullable": true
},
"employeePrimaryPhoneNumber": {
"type": "string",
"nullable": true
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"customerId": {
"type": "integer",
"format": "int64"
},
"customerName": {
"type": "string",
"nullable": true
},
"departmentName": {
"type": "string",
"nullable": true
},
"jobTitle": {
"type": "string",
"nullable": true
},
"payRate": {
"type": "number",
"format": "double"
},
"billRate": {
"type": "number",
"format": "double"
},
"startDate": {
"type": "string",
"format": "date-time"
},
"endDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"branchId": {
"type": "integer",
"format": "int32"
},
"branchName": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"isDeleted": {
"type": "boolean"
},
"jobOrderId": {
"type": "integer",
"format": "int64"
},
"supervisorId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"supervisor": {
"type": "string",
"nullable": true
},
"supervisorContactInfo": {
"type": "string",
"nullable": true
},
"originalStartDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"expectedEndDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"activeStatus": {
"type": "integer",
"format": "int32"
},
"assignmentStatusId": {
"type": "integer",
"format": "int32"
},
"assignmentStatus": {
"type": "string",
"nullable": true
},
"performanceNote": {
"type": "string",
"nullable": true
},
"isTimeclockOrder": {
"type": "boolean"
},
"serviceRep": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Messages.Assignments.AssignmentTimeclockPunchList.Result": {
"type": "object",
"properties": {
"punchId": {
"type": "string",
"format": "uuid"
},
"punchTimeUtc": {
"type": "string",
"format": "date-time"
},
"localPunchTime": {
"type": "string",
"format": "date-time"
},
"payCodeId": {
"type": "integer",
"format": "int32"
},
"payCode": {
"type": "string",
"nullable": true
},
"costCode": {
"type": "string",
"nullable": true
},
"punchStatusId": {
"type": "integer",
"format": "int32"
},
"punchStatus": {
"type": "string",
"nullable": true
},
"authMethodData": {
"type": "string",
"nullable": true
},
"metadata": {
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Messages.BackgroundChecks.BackgroundChecksSearch.Result": {
"type": "object",
"properties": {
"backgroundCheckId": {
"type": "string",
"format": "uuid"
},
"backgroundCheckStatus": {
"type": "string",
"nullable": true
},
"backgroundCheckStatusId": {
"type": "integer",
"format": "int32"
},
"backgroundCheckVendorId": {
"type": "integer",
"format": "int32"
},
"vendorName": {
"type": "string",
"nullable": true
},
"branchId": {
"type": "integer",
"format": "int32"
},
"branchName": {
"type": "string",
"nullable": true
},
"createdByServiceRepId": {
"type": "integer",
"format": "int32"
},
"createdByServiceRepFullName": {
"type": "string",
"nullable": true
},
"dateComplete": {
"type": "string",
"format": "date-time",
"nullable": true
},
"dateCreated": {
"type": "string",
"format": "date-time"
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"governmentPersonalId": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"isComplete": {
"type": "boolean"
},
"isEmployeeActive": {
"type": "boolean"
},
"isEmployeeAssigned": {
"type": "boolean"
},
"isError": {
"type": "boolean"
},
"errorMessage": {
"type": "string",
"nullable": true
},
"isInProgress": {
"type": "boolean"
},
"isQueued": {
"type": "boolean"
},
"lastModified": {
"type": "string",
"format": "date-time"
},
"reportLocation": {
"type": "string",
"nullable": true
},
"isReportLocationGeneratedOnDemand": {
"type": "boolean"
},
"requiresAttention": {
"type": "boolean"
},
"twoStepUrl": {
"type": "string",
"nullable": true
},
"vendorIdentifier": {
"type": "string",
"nullable": true
},
"vendorScore": {
"type": "string",
"nullable": true
},
"vendorStatus": {
"type": "string",
"nullable": true
},
"isVendorEnabled": {
"type": "boolean"
},
"summary": {
"type": "string",
"nullable": true
},
"reviewedByServiceRepId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"reviewedByServiceRepFullName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Messages.Branches.BranchList.Result": {
"type": "object",
"properties": {
"branchId": {
"type": "integer",
"format": "int32"
},
"branchName": {
"type": "string",
"nullable": true
},
"branchFullName": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"emailAddress": {
"type": "string",
"nullable": true
},
"phoneNumber": {
"type": "string",
"nullable": true
},
"address": {
"$ref": "#/components/schemas/TempWorks.TwApi.Common.Models.Address"
},
"region": {
"type": "string",
"nullable": true
},
"employerId": {
"type": "integer",
"format": "int32"
},
"employer": {
"type": "string",
"nullable": true
},
"hierId": {
"type": "integer",
"format": "int32"
},
"distanceToLocation": {
"type": "number",
"format": "double",
"nullable": true
},
"distanceUnit": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Messages.Contacts.ContactSummary.Result": {
"type": "object",
"properties": {
"contactId": {
"type": "integer",
"format": "int32"
},
"contactRootGuid": {
"type": "string",
"format": "uuid"
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"customerId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"customerName": {
"type": "string",
"nullable": true
},
"companyId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"companyName": {
"type": "string",
"nullable": true
},
"companyTypeId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"companyType": {
"type": "string",
"nullable": true
},
"departmentName": {
"type": "string",
"nullable": true
},
"dateCreated": {
"type": "string",
"format": "date-time",
"nullable": true
},
"note": {
"type": "string",
"nullable": true
},
"contactStatusId": {
"type": "string",
"nullable": true
},
"contactStatus": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"branchId": {
"type": "integer",
"format": "int32"
},
"branchName": {
"type": "string",
"nullable": true
},
"primaryPhoneNumberContactMethodId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"primaryPhoneNumber": {
"type": "string",
"nullable": true
},
"primaryPhoneNumberCountryCallingCode": {
"type": "integer",
"format": "int32",
"nullable": true
},
"primaryEmailAddressContactMethodId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"primaryEmailAddress": {
"type": "string",
"nullable": true
},
"address": {
"$ref": "#/components/schemas/TempWorks.TwApi.Common.Models.Address"
}
},
"additionalProperties": false
},
"TwApi.Messages.Contacts.CreateContact.Result": {
"type": "object",
"properties": {
"contactId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Messages.CustomData.GetPropertyDefinitions.Response": {
"type": "object",
"properties": {
"propertyDefinitionId": {
"type": "string",
"format": "uuid"
},
"originTypeId": {
"type": "integer",
"format": "int32"
},
"propertyName": {
"type": "string",
"nullable": true
},
"isRequired": {
"type": "boolean"
},
"hierId": {
"type": "integer",
"format": "int32"
},
"isActive": {
"type": "boolean"
},
"searchCategoryId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"allowMultipleValues": {
"type": "boolean"
},
"datalistValues": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"categoryId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"propertyType": {
"type": "string",
"nullable": true
},
"canEdit": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Messages.Customers.CreateCustomer.Result": {
"type": "object",
"properties": {
"customerId": {
"type": "integer",
"format": "int64"
}
},
"additionalProperties": false
},
"TwApi.Messages.Customers.CustomerSummary.Result": {
"type": "object",
"properties": {
"customerId": {
"type": "integer",
"format": "int64"
},
"customerRootGuid": {
"type": "string",
"format": "uuid"
},
"customerName": {
"type": "string",
"nullable": true
},
"departmentName": {
"type": "string",
"nullable": true
},
"parentCustomerId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"rootCustomerId": {
"type": "integer",
"format": "int64"
},
"branchId": {
"type": "integer",
"format": "int32"
},
"branchName": {
"type": "string",
"nullable": true
},
"customerStatusId": {
"type": "string",
"nullable": true
},
"customerStatus": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"primaryPhoneNumberContactMethodId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"primaryPhoneNumber": {
"type": "string",
"nullable": true
},
"primaryPhoneNumberCountryCallingCode": {
"type": "integer",
"format": "int32",
"nullable": true
},
"primaryEmailAddressContactMethodId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"primaryEmailAddress": {
"type": "string",
"nullable": true
},
"address": {
"$ref": "#/components/schemas/TempWorks.TwApi.Common.Models.Address"
}
},
"additionalProperties": false
},
"TwApi.Messages.EmailAccounts.EmailAccountDetailsResult": {
"type": "object",
"properties": {
"accountId": {
"type": "integer",
"format": "int32"
},
"description": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"senderEmail": {
"type": "string",
"nullable": true
},
"senderName": {
"type": "string",
"nullable": true
},
"replyTo": {
"type": "string",
"nullable": true
},
"defaultSignatureId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"defaultSignatureGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"defaultSignature": {
"type": "string",
"nullable": true
},
"serviceTypeId": {
"type": "integer",
"format": "int32"
},
"serviceType": {
"type": "string",
"nullable": true
},
"smtpSettings": {
"$ref": "#/components/schemas/TwApi.Common.Models.ExternalServices.PossiblyCensoredEmailBasicAuthCredentials"
},
"oAuthEmailCredentials": {
"$ref": "#/components/schemas/TwApi.Common.Models.ExternalServices.EmailOAuthCredentials"
},
"teams": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Messages.EmailAccounts.EmailAccountDetailsResult.EmailAccountTeam"
},
"nullable": true
},
"createdByServiceRep": {
"type": "string",
"nullable": true
},
"createdByServiceRepId": {
"type": "integer",
"format": "int32"
},
"dateCreated": {
"type": "string",
"format": "date-time"
},
"isSystemEmailAccount": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Messages.EmailAccounts.EmailAccountDetailsResult.EmailAccountTeam": {
"type": "object",
"properties": {
"teamId": {
"type": "integer",
"format": "int32"
},
"team": {
"type": "string",
"nullable": true
},
"teamGuid": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"TwApi.Messages.Employees.EmployeeDetails.Result": {
"type": "object",
"properties": {
"employeeId": {
"type": "integer",
"format": "int64"
},
"employeeGuid": {
"type": "string",
"format": "uuid"
},
"branchId": {
"type": "integer",
"format": "int32"
},
"branch": {
"type": "string",
"nullable": true
},
"hierTypeId": {
"type": "integer",
"format": "int32"
},
"hierType": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"middleName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"alias": {
"type": "string",
"nullable": true
},
"namePrefix": {
"type": "string",
"nullable": true
},
"nameSuffix": {
"type": "string",
"nullable": true
},
"governmentPersonalId": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"activationDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"deactivationDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"resumeDocumentId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"resumeFileName": {
"type": "string",
"nullable": true
},
"isI9OnFile": {
"type": "boolean"
},
"i9ExpirationDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"jobTitle": {
"type": "string",
"nullable": true
},
"note": {
"type": "string",
"nullable": true
},
"numericRating": {
"type": "integer",
"format": "int32"
},
"serviceRepId": {
"type": "integer",
"format": "int32"
},
"serviceRep": {
"type": "string",
"nullable": true
},
"serviceRepChatName": {
"type": "string",
"nullable": true
},
"serviceRepEmail": {
"type": "string",
"nullable": true
},
"createdByServiceRepId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"createdByServiceRep": {
"type": "string",
"nullable": true
},
"companyId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"company": {
"type": "string",
"nullable": true
},
"companyIsVendor": {
"type": "boolean",
"nullable": true
},
"alternateEmployeeId": {
"type": "string",
"nullable": true
},
"address": {
"$ref": "#/components/schemas/TempWorks.TwApi.Common.Models.Address"
},
"employerId": {
"type": "integer",
"format": "int32"
},
"employer": {
"type": "string",
"nullable": true
},
"driverLicenseNumber": {
"type": "string",
"nullable": true
},
"driverLicenseState": {
"type": "string",
"nullable": true
},
"driverLicenseClass": {
"type": "string",
"nullable": true
},
"driverLicenseExpire": {
"type": "string",
"format": "date-time"
},
"primaryPhoneNumberContactMethodId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"primaryPhoneNumber": {
"type": "string",
"nullable": true
},
"primaryPhoneNumberContactMethodTypeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"primaryPhoneNumberContactMethodType": {
"type": "string",
"nullable": true
},
"primaryPhoneNumberCountryCallingCode": {
"type": "integer",
"format": "int32",
"nullable": true
},
"primaryEmailAddressContactMethodId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"primaryEmailAddress": {
"type": "string",
"nullable": true
},
"primaryEmailAddressContactMethodTypeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"primaryEmailAddressContactMethodType": {
"type": "string",
"nullable": true
},
"employeeStatusId": {
"type": "string",
"nullable": true
},
"employeeStatus": {
"type": "string",
"nullable": true
},
"isAssigned": {
"type": "boolean"
},
"governmentPersonalIdIsScrubbed": {
"type": "boolean"
},
"birthday": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Messages.ExternalService.CredentialsDetails.Result": {
"type": "object",
"properties": {
"credentialsId": {
"type": "integer",
"format": "int64"
},
"externalServiceId": {
"type": "integer",
"format": "int64"
},
"externalService": {
"type": "string",
"nullable": true
},
"visibilityMethodId": {
"type": "integer",
"format": "int64"
},
"visibilityMethod": {
"type": "string",
"nullable": true
},
"visibilityId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"visibility": {
"type": "string",
"nullable": true
},
"visibilityLevelId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"visibilityLevel": {
"type": "string",
"nullable": true
},
"encryptionTypeId": {
"type": "integer",
"format": "int64"
},
"encryptionType": {
"type": "string",
"nullable": true
},
"credentials": {
"nullable": true
},
"canEdit": {
"type": "boolean"
},
"isAboveCurrentUserHierarchy": {
"type": "boolean"
},
"tenant": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Messages.JobOrders.JobOrderDetails.Result": {
"type": "object",
"properties": {
"localizedJobOrderDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.LocalizedJobOrderDetails"
},
"nullable": true
},
"worksiteId": {
"type": "integer",
"format": "int32"
},
"jobOrderId": {
"type": "integer",
"format": "int64"
},
"orderRootGuid": {
"type": "string",
"format": "uuid"
},
"branchId": {
"type": "integer",
"format": "int32"
},
"branch": {
"type": "string",
"nullable": true
},
"jobOrderTypeId": {
"type": "integer",
"format": "int32"
},
"jobOrderType": {
"type": "string",
"nullable": true
},
"jobTitleId": {
"type": "integer",
"format": "int32"
},
"jobTitle": {
"type": "string",
"nullable": true
},
"jobDescription": {
"type": "string",
"nullable": true
},
"payRate": {
"type": "number",
"format": "double",
"nullable": true
},
"billRate": {
"type": "number",
"format": "double",
"nullable": true
},
"jobOrderStatusId": {
"type": "integer",
"format": "int32"
},
"jobOrderStatus": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"positionsRequired": {
"type": "integer",
"format": "int32"
},
"positionsFilled": {
"type": "integer",
"format": "int32"
},
"customerId": {
"type": "integer",
"format": "int64"
},
"customerName": {
"type": "string",
"nullable": true
},
"departmentName": {
"type": "string",
"nullable": true
},
"jobOrderDurationId": {
"type": "integer",
"format": "int32"
},
"jobOrderDuration": {
"type": "string",
"nullable": true
},
"dateOrderTaken": {
"type": "string",
"format": "date-time"
},
"startDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"supervisorContactId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"supervisorFirstName": {
"type": "string",
"nullable": true
},
"supervisorLastName": {
"type": "string",
"nullable": true
},
"supervisorOfficePhoneCountryCallingCode": {
"type": "integer",
"format": "int32",
"nullable": true
},
"supervisorOfficePhone": {
"type": "string",
"nullable": true
},
"supervisorEmailAddress": {
"type": "string",
"nullable": true
},
"doNotAutoClose": {
"type": "boolean"
},
"usesTimeClock": {
"type": "boolean"
},
"usesPeopleNet": {
"type": "boolean"
},
"notes": {
"type": "string",
"nullable": true
},
"alternateJobOrderId": {
"type": "string",
"nullable": true
},
"dressCode": {
"type": "string",
"nullable": true
},
"safetyNotes": {
"type": "string",
"nullable": true
},
"directions": {
"type": "string",
"nullable": true
},
"serviceRepId": {
"type": "integer",
"format": "int32"
},
"serviceRep": {
"type": "string",
"nullable": true
},
"salesTeamId": {
"type": "integer",
"format": "int32"
},
"salesTeam": {
"type": "string",
"nullable": true
},
"publicJobTitle": {
"type": "string",
"nullable": true
},
"publicJobDescription": {
"type": "string",
"nullable": true
},
"publicPostingDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"doNotPostPublicly": {
"type": "boolean"
},
"publicJobDescriptionContentType": {
"type": "string",
"nullable": true
},
"publicEducationSummary": {
"type": "string",
"nullable": true
},
"publicExperienceSummary": {
"type": "string",
"nullable": true
},
"showPayRate": {
"type": "boolean"
},
"showWorksiteAddress": {
"type": "boolean"
},
"isDirectHireJobOrder": {
"type": "boolean"
},
"remoteWorkStatusId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"remoteWorkStatus": {
"type": "string",
"nullable": true
},
"vmsPositionsRequired": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Messages.Notifications.UserNotificationUnsubscriptionsQuery.Result": {
"type": "object",
"properties": {
"notificationPreferenceId": {
"type": "integer",
"format": "int64"
},
"originId": {
"type": "integer",
"format": "int64"
},
"originTypeId": {
"type": "integer",
"format": "int32"
},
"notificationTypeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"notificationTypeName": {
"type": "string",
"nullable": true
},
"notificationTypeDescription": {
"type": "string",
"nullable": true
},
"notificationCategoryId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"notificationCategoryName": {
"type": "string",
"nullable": true
},
"notificationCategoryDescription": {
"type": "string",
"nullable": true
},
"notificationMethodId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"notificationMethodName": {
"type": "string",
"nullable": true
},
"notificationMethodDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Messages.Onboarding.Onboarding2ActionMetadataByEmployeeSearch.Result": {
"type": "object",
"properties": {
"onboarding2ActionMetadataId": {
"type": "integer",
"format": "int64"
},
"actionId": {
"type": "string",
"nullable": true
},
"actionName": {
"type": "string",
"nullable": true
},
"dateCreated": {
"type": "string",
"format": "date-time",
"nullable": true
},
"dueDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"dateExpired": {
"type": "string",
"format": "date-time",
"nullable": true
},
"dateCompleted": {
"type": "string",
"format": "date-time",
"nullable": true
},
"dateUpdated": {
"type": "string",
"format": "date-time",
"nullable": true
},
"assignee": {
"type": "string",
"nullable": true
},
"status": {
"type": "string",
"nullable": true
},
"productInstanceId": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Messages.Onboarding.Onboarding2ActionMetadataEmployeeList.Result": {
"type": "object",
"properties": {
"employeeId": {
"type": "integer",
"format": "int64"
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"branchName": {
"type": "string",
"nullable": true
},
"repFullName": {
"type": "string",
"nullable": true
},
"primaryPhoneNumberCountryCallingCode": {
"type": "integer",
"format": "int32",
"nullable": true
},
"primaryPhoneNumber": {
"type": "string",
"nullable": true
},
"primaryEmailAddress": {
"type": "string",
"nullable": true
},
"totalActionsThatRequireAttention": {
"type": "integer",
"format": "int32"
},
"totalActionsThatRequireAttentionByAssigneeAndFilters": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Messages.Prospects.ProspectDetails.Result": {
"type": "object",
"properties": {
"prospectId": {
"type": "integer",
"format": "int64"
},
"prospectGuid": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"department": {
"type": "string",
"nullable": true
},
"prospectStatusId": {
"type": "integer",
"format": "int64"
},
"prospectStatus": {
"type": "string",
"nullable": true
},
"address": {
"$ref": "#/components/schemas/TempWorks.TwApi.Common.Models.Address"
},
"phoneNumber": {
"type": "string",
"nullable": true
},
"phoneNumberCountryCallingCode": {
"type": "integer",
"format": "int32",
"nullable": true
},
"emailAddress": {
"type": "string",
"nullable": true
},
"notes": {
"type": "string",
"nullable": true
},
"source": {
"type": "string",
"nullable": true
},
"primaryProspectContactId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"primaryProspectContactFirstName": {
"type": "string",
"nullable": true
},
"primaryProspectContactLastName": {
"type": "string",
"nullable": true
},
"primaryProspectContactTitle": {
"type": "string",
"nullable": true
},
"dateCreated": {
"type": "string",
"format": "date-time"
},
"createdByServiceRepId": {
"type": "integer",
"format": "int32"
},
"createdByServiceRep": {
"type": "string",
"nullable": true
},
"ownedByServiceRepId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"ownedByServiceRep": {
"type": "string",
"nullable": true
},
"teamId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"team": {
"type": "string",
"nullable": true
},
"dateConvertedToCustomer": {
"type": "string",
"format": "date-time",
"nullable": true
},
"convertedToCustomerId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"convertedToCustomerName": {
"type": "string",
"nullable": true
},
"convertedToDepartmentName": {
"type": "string",
"nullable": true
},
"convertedToCustomerByServiceRepId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"convertedToCustomerByServiceRep": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Messages.System.CreateServiceRepTokenData.Response": {
"type": "object",
"properties": {
"accountSid": {
"type": "string",
"nullable": true
},
"authToken": {
"type": "string",
"nullable": true
},
"allowedScopesCsv": {
"type": "string",
"nullable": true
},
"twToken": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Messages.Texting.SendTextMessageToContactMethod.Result": {
"type": "object",
"properties": {
"externalServicePortalUrl": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Messages.Timeclock.OnSiteTimeClockAuthDataQuery.Result": {
"type": "object",
"properties": {
"authMethodDataId": {
"type": "integer",
"format": "int32"
},
"authMethodId": {
"type": "integer",
"format": "int32"
},
"authMethodDataTypeId": {
"type": "integer",
"format": "int32"
},
"authMethodMediaId": {
"type": "integer",
"format": "int32"
},
"authMethodName": {
"type": "string",
"nullable": true
},
"authMethodDescription": {
"type": "string",
"nullable": true
},
"authMethodDataTypeName": {
"type": "string",
"nullable": true
},
"authMethodDataTypeDescription": {
"type": "string",
"nullable": true
},
"authMethodMediaName": {
"type": "string",
"nullable": true
},
"authMethodMediaDescription": {
"type": "string",
"nullable": true
},
"personalIdentifier": {
"type": "string",
"nullable": true
},
"authData": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Messages.Timeclock.PunchListByDayQuery.Result": {
"type": "object",
"properties": {
"day": {
"type": "string",
"format": "date-time"
},
"totalHoursOfWorkForDay": {
"type": "number",
"format": "double"
},
"punches": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Messages.Timeclock.PunchListByDayQuery.TimeclockPunch"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Messages.Timeclock.PunchListByDayQuery.TimeclockPunch": {
"type": "object",
"properties": {
"punchId": {
"type": "string",
"format": "uuid"
},
"localPunchTime": {
"type": "string",
"format": "date-time"
},
"punchTimeUtc": {
"type": "string",
"format": "date-time"
},
"payCodeId": {
"type": "integer",
"format": "int32"
},
"payCode": {
"type": "string",
"nullable": true
},
"payCodeDescription": {
"type": "string",
"nullable": true
},
"costCode": {
"type": "string",
"nullable": true
},
"punchStatusId": {
"type": "integer",
"format": "int32"
},
"isPunchIn": {
"type": "boolean"
},
"punchStatus": {
"type": "string",
"nullable": true
},
"timeclockTimecardId": {
"type": "string",
"format": "uuid"
},
"weekendDate": {
"type": "string",
"format": "date-time"
},
"timeclockTimecardShiftNumber": {
"type": "integer",
"format": "int32"
},
"timeclockTimecardShiftId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"TwApi.Messages.Timeclock.TimeclockPunchMessageData.Result": {
"type": "object",
"properties": {
"punchId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"TwApi.Services.Assessments.API.Models.CreateAssessmentPackageRequest": {
"required": [
"hierId",
"packageDescription",
"packageName"
],
"type": "object",
"properties": {
"packageName": {
"maxLength": 100,
"minLength": 0,
"type": "string",
"description": "The name of the package."
},
"packageDescription": {
"maxLength": 2000,
"minLength": 0,
"type": "string",
"description": "A description of the package."
},
"hierId": {
"type": "integer",
"description": "The HierId the package will be available at. A list of hiers can be found at the datalists/hiers endpoint.",
"format": "int32"
}
},
"additionalProperties": false,
"description": "A request to create a Package of Assessments."
},
"TwApi.Services.Assessments.API.Models.CreateAssessmentSessionRequest": {
"type": "object",
"properties": {
"locale": {
"type": "string",
"description": "The language to be used.",
"nullable": true
},
"sessionRequestOverrides": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.AssessmentSessionFormFields"
},
"assessments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.API.Models.CreateAssessmentSessionRequest.AssessmentRequest"
},
"description": "The list of assessments to generate assessment sessions for. Items in this list may be ignored if they exist in an assessment package.",
"nullable": true
},
"packages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.API.Models.CreateAssessmentSessionRequest.PackageRequest"
},
"description": "The list of packages used to generate assessment sessions for.\r\n Depending upon the vendor, duplicate assessments within packages may be ignored.\r\n Assessments in the package may also be ignored if the assessments list contains the same assessments.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to assign Assessments to an Employee"
},
"TwApi.Services.Assessments.API.Models.CreateAssessmentSessionRequest.AssessmentRequest": {
"type": "object",
"properties": {
"assessmentVendorId": {
"type": "integer",
"description": "The Id of the assessment vendor.",
"format": "int32"
},
"assessmentId": {
"type": "string",
"description": "The vendor identifier for the assessment.",
"nullable": true
}
},
"additionalProperties": false,
"description": "An assessment to be assigned."
},
"TwApi.Services.Assessments.API.Models.CreateAssessmentSessionRequest.PackageRequest": {
"type": "object",
"properties": {
"assessmentVendorId": {
"type": "integer",
"description": "The Id of the assessment vendor.",
"format": "int32"
},
"packageId": {
"type": "string",
"description": "The vendor identifier for the package.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A package of assessments to be assigned."
},
"TwApi.Services.Assessments.API.Models.CreateUserDefinedPackageMemberRequest": {
"required": [
"assessmentVendorId"
],
"type": "object",
"properties": {
"assessmentVendorId": {
"type": "integer",
"description": "The Id of the assessment vendor.",
"format": "int32"
},
"assessmentId": {
"maxLength": 100,
"minLength": 0,
"type": "string",
"description": "The vendor identifier for the assessment.\r\nValue is for backwards compatibility only",
"nullable": true,
"deprecated": true
},
"vendorMemberId": {
"type": "string",
"description": "The unique identifier for the package/assessment for the vendor.",
"nullable": true
},
"packageMemberTypeId": {
"type": "integer",
"description": "1 if an Assessment and 2 if a package.",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to add an assessment or Package to a Assessment Package.\r\nAble to now add either an"
},
"TwApi.Services.Assessments.Service.AssessmentPackageMemberTypeEnum": {
"enum": [
1,
2
],
"type": "integer",
"format": "int32"
},
"TwApi.Services.Assessments.Service.AssessmentSessionFormFields": {
"type": "object",
"properties": {
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"emailAddress": {
"type": "string",
"nullable": true
},
"sendInvitationEmail": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Assessments.Service.Commands.AssessmentOrgsQuery.Result": {
"type": "object",
"properties": {
"orgs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.AssessmentOrgsQuery.Result"
},
"nullable": true
},
"orgName": {
"type": "string",
"nullable": true
},
"orgUnitId": {
"type": "string",
"nullable": true
},
"accountId": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Assessments.Service.Commands.AssessmentPackagesQuery.Result": {
"type": "object",
"properties": {
"packageId": {
"type": "string",
"nullable": true
},
"packageName": {
"type": "string",
"nullable": true
},
"packageDescription": {
"type": "string",
"nullable": true
},
"assessmentVendorId": {
"type": "integer",
"format": "int32"
},
"assessmentVendorName": {
"type": "string",
"nullable": true
},
"numberOfAssessments": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Assessments.Service.Commands.AssessmentSessionFormFieldsQuery.Result": {
"type": "object",
"properties": {
"formFields": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.AssessmentSessionFormFields"
}
},
"additionalProperties": false
},
"TwApi.Services.Assessments.Service.Commands.AssessmentSessionsQuery.Result": {
"type": "object",
"properties": {
"assessmentSessionId": {
"type": "integer",
"format": "int64"
},
"originId": {
"type": "integer",
"format": "int64"
},
"originTypeId": {
"type": "integer",
"format": "int32"
},
"lastName": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"vendorSessionId": {
"type": "string",
"nullable": true
},
"assessmentVendorId": {
"type": "integer",
"format": "int32"
},
"assessmentVendorName": {
"type": "string",
"nullable": true
},
"assessmentId": {
"type": "string",
"nullable": true
},
"assessmentName": {
"type": "string",
"nullable": true
},
"sessionExpirationDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"sessionUrl": {
"type": "string",
"nullable": true
},
"reportUrls": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"score": {
"type": "string",
"nullable": true
},
"grade": {
"type": "string",
"nullable": true
},
"sessionStatus": {
"type": "string",
"nullable": true
},
"isComplete": {
"type": "boolean"
},
"isActive": {
"type": "boolean"
},
"dateCreated": {
"type": "string",
"format": "date-time"
},
"dateModified": {
"type": "string",
"format": "date-time"
},
"dateCompleted": {
"type": "string",
"format": "date-time",
"nullable": true
},
"canUpdateStatus": {
"type": "boolean",
"readOnly": true
},
"canUpdateResults": {
"type": "boolean",
"readOnly": true
},
"createdBySrIdent": {
"type": "integer",
"format": "int32"
},
"createdByServiceRep": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Assessments.Service.Commands.AssessmentVendorsQuery.Result": {
"type": "object",
"properties": {
"assessmentVendorId": {
"type": "integer",
"format": "int32"
},
"assessmentVendorName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Assessments.Service.Commands.AssessmentsQuery.Result": {
"type": "object",
"properties": {
"assessmentId": {
"type": "string",
"nullable": true
},
"assessmentVendorName": {
"type": "string",
"nullable": true
},
"assessmentVendorId": {
"type": "integer",
"format": "int32"
},
"assessmentName": {
"type": "string",
"nullable": true
},
"assessmentDescription": {
"type": "string",
"nullable": true
},
"categoryId": {
"type": "string",
"nullable": true
},
"category": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Assessments.Service.Commands.CreateAssessmentSessionsCommand.Result": {
"type": "object",
"properties": {
"sessionResponses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.CreateAssessmentSessionsCommand.Result.CreateSessionResponse"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Assessments.Service.Commands.CreateAssessmentSessionsCommand.Result.CreateSessionResponse": {
"type": "object",
"properties": {
"assessmentVendorId": {
"type": "integer",
"format": "int32"
},
"assessmentVendorName": {
"type": "string",
"nullable": true
},
"assessmentId": {
"type": "string",
"nullable": true
},
"assessmentName": {
"type": "string",
"nullable": true
},
"assessmentSessionId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"vendorSessionId": {
"type": "string",
"nullable": true
},
"sessionUrl": {
"type": "string",
"nullable": true
},
"sessionExpirationDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"isError": {
"type": "boolean"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.CreateAssessmentSessionsCommand.Result.Error"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Assessments.Service.Commands.CreateAssessmentSessionsCommand.Result.Error": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"nullable": true
},
"fieldName": {
"type": "string",
"nullable": true
},
"message": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Assessments.Service.Commands.CreateUserDefinedPackage.Response": {
"type": "object",
"properties": {
"assessmentPackageId": {
"type": "integer",
"format": "int64"
}
},
"additionalProperties": false
},
"TwApi.Services.Assessments.Service.Commands.CreateUserDefinedPackageMember.Response": {
"type": "object",
"properties": {
"assessmentPackageMemberId": {
"type": "integer",
"format": "int64"
}
},
"additionalProperties": false
},
"TwApi.Services.Assessments.Service.Commands.LocalesQuery.Result": {
"type": "object",
"properties": {
"locale": {
"type": "string",
"nullable": true
},
"isDefault": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Assessments.Service.Commands.PostAssessOnCloudResultsCommand.AssessOnCloudSessionPostedResult": {
"type": "object",
"properties": {
"candidates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.PostAssessOnCloudResultsCommand.AssessOnCloudSessionPostedResult.Candidate"
},
"nullable": true
},
"requestStatus": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.PostAssessOnCloudResultsCommand.AssessOnCloudSessionPostedResult.RequestStatusObj"
}
},
"additionalProperties": false
},
"TwApi.Services.Assessments.Service.Commands.PostAssessOnCloudResultsCommand.AssessOnCloudSessionPostedResult.Batch": {
"type": "object",
"properties": {
"batchId": {
"type": "string",
"nullable": true
},
"externalInfo": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.PostAssessOnCloudResultsCommand.AssessOnCloudSessionPostedResult.ExternalInfo"
},
"batchCompleted": {
"type": "boolean"
},
"batchSessionId": {
"type": "string",
"nullable": true
},
"managerId": {
"type": "string",
"nullable": true
},
"orderId": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Assessments.Service.Commands.PostAssessOnCloudResultsCommand.AssessOnCloudSessionPostedResult.Candidate": {
"type": "object",
"properties": {
"email": {
"type": "string",
"nullable": true
},
"jobs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.PostAssessOnCloudResultsCommand.AssessOnCloudSessionPostedResult.Job"
},
"nullable": true
},
"candidateId": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"postResultsUrls": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.PostAssessOnCloudResultsCommand.AssessOnCloudSessionPostedResult.PostResultsUrl"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Assessments.Service.Commands.PostAssessOnCloudResultsCommand.AssessOnCloudSessionPostedResult.Dimension": {
"type": "object",
"properties": {
"localeName": {
"type": "string",
"nullable": true
},
"dimensions": {
"type": "array",
"items": { },
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"category": {
"type": "string",
"nullable": true
},
"dimensionId": {
"type": "string",
"nullable": true
},
"gradeBand": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.PostAssessOnCloudResultsCommand.AssessOnCloudSessionPostedResult.GradeBand"
},
"displayScore": {
"type": "string",
"nullable": true
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.PostAssessOnCloudResultsCommand.AssessOnCloudSessionPostedResult.Item"
},
"nullable": true
},
"scoreType": {
"type": "string",
"nullable": true
},
"numericScore": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"rawScore": {
"type": "string",
"nullable": true
},
"type": {
"type": "string",
"nullable": true
},
"tScore": {
"type": "string",
"nullable": true
},
"zScore": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Assessments.Service.Commands.PostAssessOnCloudResultsCommand.AssessOnCloudSessionPostedResult.ExternalInfo": {
"type": "object",
"properties": {
"field2": {
"nullable": true
},
"field4": {
"nullable": true
},
"field1": {
"nullable": true
},
"field3": {
"nullable": true
},
"field5": {
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Assessments.Service.Commands.PostAssessOnCloudResultsCommand.AssessOnCloudSessionPostedResult.GradeBand": {
"type": "object",
"properties": {
"gradeRangeFrom": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"color": {
"nullable": true
},
"feedback": {
"nullable": true
},
"localeName": {
"type": "string",
"nullable": true
},
"gradeRangeTo": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"proficiencyLevel": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.PostAssessOnCloudResultsCommand.AssessOnCloudSessionPostedResult.ProficiencyLevel"
}
},
"additionalProperties": false
},
"TwApi.Services.Assessments.Service.Commands.PostAssessOnCloudResultsCommand.AssessOnCloudSessionPostedResult.Instrument": {
"type": "object",
"properties": {
"instrumentId": {
"type": "string",
"format": "uuid"
},
"overallNumericScore": {
"type": "string",
"nullable": true
},
"displayScore": {
"type": "string",
"nullable": true
},
"completeDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"batchs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.PostAssessOnCloudResultsCommand.AssessOnCloudSessionPostedResult.Batch"
},
"nullable": true
},
"dimensions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.PostAssessOnCloudResultsCommand.AssessOnCloudSessionPostedResult.Dimension"
},
"nullable": true
},
"externalInfo": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.PostAssessOnCloudResultsCommand.AssessOnCloudSessionPostedResult.ExternalInfo"
},
"elapsedTime": {
"type": "string",
"nullable": true
},
"gradeBand": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.PostAssessOnCloudResultsCommand.AssessOnCloudSessionPostedResult.GradeBand"
},
"maxDimDepth": {
"type": "string",
"nullable": true
},
"instrumentType": {
"type": "string",
"nullable": true
},
"instrumentName": {
"type": "string",
"nullable": true
},
"managerId": {
"type": "string",
"nullable": true
},
"orderId": {
"type": "string",
"nullable": true
},
"moreReportDetails": {
"type": "boolean"
},
"overallEvaluationText": {
"type": "string",
"nullable": true
},
"reportLinks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.PostAssessOnCloudResultsCommand.AssessOnCloudSessionPostedResult.ReportLink"
},
"nullable": true
},
"status": {
"type": "string",
"nullable": true
},
"questionsCorrect": {
"type": "string",
"nullable": true
},
"overallScoreType": {
"type": "string",
"nullable": true
},
"rawScore": {
"type": "string",
"nullable": true
},
"returnCandidateURL": {
"type": "string",
"nullable": true
},
"resultsExpire": {
"type": "string",
"nullable": true
},
"sessionId": {
"type": "string",
"format": "uuid"
},
"totalQuestions": {
"type": "string",
"nullable": true
},
"tScore": {
"type": "string",
"nullable": true
},
"zScore": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Assessments.Service.Commands.PostAssessOnCloudResultsCommand.AssessOnCloudSessionPostedResult.Item": {
"type": "object",
"properties": {
"isCorrect": {
"type": "string",
"nullable": true
},
"id": {
"type": "string",
"nullable": true
},
"responseType": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Assessments.Service.Commands.PostAssessOnCloudResultsCommand.AssessOnCloudSessionPostedResult.Job": {
"type": "object",
"properties": {
"instruments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.PostAssessOnCloudResultsCommand.AssessOnCloudSessionPostedResult.Instrument"
},
"nullable": true
},
"reqLanguageDisplay": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Assessments.Service.Commands.PostAssessOnCloudResultsCommand.AssessOnCloudSessionPostedResult.PostResultsUrl": {
"type": "object",
"properties": {
"locale": {
"type": "string",
"nullable": true
},
"format": {
"type": "string",
"nullable": true
},
"url": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Assessments.Service.Commands.PostAssessOnCloudResultsCommand.AssessOnCloudSessionPostedResult.ProficiencyLevel": {
"type": "object",
"properties": {
"description": {
"type": "string",
"nullable": true
},
"localeName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Assessments.Service.Commands.PostAssessOnCloudResultsCommand.AssessOnCloudSessionPostedResult.ReportLink": {
"type": "object",
"properties": {
"reportType": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"url": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Assessments.Service.Commands.PostAssessOnCloudResultsCommand.AssessOnCloudSessionPostedResult.RequestStatusObj": {
"type": "object",
"properties": {
"message": {
"nullable": true
},
"result": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Assessments.Service.Commands.PostAssessOnCloudResultsCommand.Result.AssessOnCloudAcknowledgment": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Assessments.Service.Commands.UpdateAssessOnCloudSessionStatus.AssessOnCloudSessionStatus": {
"type": "object",
"properties": {
"requestStatus": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.UpdateAssessOnCloudSessionStatus.AssessOnCloudSessionStatus.RequestStatusObj"
},
"sessions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.UpdateAssessOnCloudSessionStatus.AssessOnCloudSessionStatus.Session"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Assessments.Service.Commands.UpdateAssessOnCloudSessionStatus.AssessOnCloudSessionStatus.Candidate": {
"type": "object",
"properties": {
"email": {
"type": "string",
"nullable": true
},
"candidateId": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Assessments.Service.Commands.UpdateAssessOnCloudSessionStatus.AssessOnCloudSessionStatus.ExternalInfo": {
"type": "object",
"properties": {
"field2": {
"type": "string",
"nullable": true
},
"field4": {
"type": "string",
"nullable": true
},
"field1": {
"type": "string",
"nullable": true
},
"field3": {
"type": "string",
"nullable": true
},
"field5": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Assessments.Service.Commands.UpdateAssessOnCloudSessionStatus.AssessOnCloudSessionStatus.RequestStatusObj": {
"type": "object",
"properties": {
"message": {
"type": "string",
"nullable": true
},
"result": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Assessments.Service.Commands.UpdateAssessOnCloudSessionStatus.AssessOnCloudSessionStatus.Session": {
"type": "object",
"properties": {
"instrumentId": {
"type": "string",
"format": "uuid"
},
"candidateLocaleName": {
"type": "string",
"nullable": true
},
"candidate": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.UpdateAssessOnCloudSessionStatus.AssessOnCloudSessionStatus.Candidate"
},
"externalInfo": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.Commands.UpdateAssessOnCloudSessionStatus.AssessOnCloudSessionStatus.ExternalInfo"
},
"sessionId": {
"type": "string",
"format": "uuid"
},
"orgUnitId": {
"type": "string",
"nullable": true
},
"sessionUrl": {
"type": "string",
"nullable": true
},
"status": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Assessments.Service.Commands.UpdateAssessOnCloudSessionStatus.Result.AssessOnCloudAcknowledgment": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Assessments.Service.Commands.UpdateAssessmentSessionResultsCommand.Result": {
"type": "object",
"properties": {
"resultsUpdated": {
"type": "boolean"
},
"message": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Assessments.Service.Commands.UpdateAssessmentSessionStatusCommand.Result": {
"type": "object",
"properties": {
"statusUpdated": {
"type": "boolean"
},
"resultsUpdated": {
"type": "boolean"
},
"message": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Assessments.Service.Commands.UserDefinedPackageMembersQuery.Result": {
"type": "object",
"properties": {
"assessmentPackageMemberId": {
"type": "integer",
"format": "int32"
},
"assessmentVendorId": {
"type": "integer",
"format": "int32"
},
"assessmentVendorName": {
"type": "string",
"nullable": true
},
"assessmentId": {
"type": "string",
"nullable": true,
"readOnly": true,
"deprecated": true
},
"assessmentName": {
"type": "string",
"nullable": true,
"readOnly": true,
"deprecated": true
},
"assessmentCategoryId": {
"type": "string",
"nullable": true,
"readOnly": true,
"deprecated": true
},
"assessmentCategoryName": {
"type": "string",
"nullable": true,
"readOnly": true,
"deprecated": true
},
"vendorMemberId": {
"type": "string",
"nullable": true
},
"vendorMemberName": {
"type": "string",
"nullable": true
},
"packageMemberTypeId": {
"$ref": "#/components/schemas/TwApi.Services.Assessments.Service.AssessmentPackageMemberTypeEnum"
},
"packageMemberType": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Assessments.Service.Commands.UserDefinedPackagesQuery.Result": {
"type": "object",
"properties": {
"assessmentPackageId": {
"type": "integer",
"format": "int32"
},
"packageName": {
"type": "string",
"nullable": true
},
"packageDescription": {
"type": "string",
"nullable": true
},
"hierId": {
"type": "integer",
"format": "int32"
},
"numberOfAssessments": {
"type": "integer",
"format": "int32",
"deprecated": true
},
"canEdit": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Assignments.API.Models.CommissionAllocation": {
"required": [
"branchId",
"commissionBase",
"creditTypeId",
"serviceRepId"
],
"type": "object",
"properties": {
"serviceRepId": {
"type": "integer",
"description": "The service rep this allocation applies to",
"format": "int32"
},
"creditTypeId": {
"type": "integer",
"description": "The type of credit that this commission allocation represents (i.e. sales vs recruiter)",
"format": "int32"
},
"branchId": {
"type": "integer",
"description": "The branch that the commission payments will come from",
"format": "int32"
},
"commissionBase": {
"maximum": 200,
"minimum": 1,
"type": "number",
"description": "A number representing a percentage of the total commission\r\n for the assignment that will be allocated to the service rep.",
"format": "double"
}
},
"additionalProperties": false,
"description": "A request to update or delete a Commission Allocation for the Assignment."
},
"TwApi.Services.Assignments.API.Models.CreateAssignmentAccrualRequest": {
"required": [
"accrualId",
"isActive"
],
"type": "object",
"properties": {
"accrualId": {
"type": "string",
"description": "The Accrual Id",
"format": "uuid"
},
"isActive": {
"type": "boolean",
"description": "Indicates if the accrual is active."
}
},
"additionalProperties": false,
"description": "A request to create an accrual for an assignment."
},
"TwApi.Services.Assignments.API.Models.CreateAssignmentAdjustmentRequest": {
"required": [
"adjustmentId",
"payCodeId"
],
"type": "object",
"properties": {
"adjustmentId": {
"type": "integer",
"description": "The Id of the Adjustment that is added to the Assignment.",
"format": "int32"
},
"payCodeId": {
"type": "integer",
"description": "The Id of the PayCode that is set when adding the Adjustment to the Assignment.",
"format": "int32"
},
"defaultPayRate": {
"maximum": 99999999.9999,
"minimum": -99999999.9999,
"type": "number",
"description": "The PayRate.",
"format": "double",
"nullable": true
},
"defaultBillRate": {
"maximum": 99999999.9999,
"minimum": -99999999.9999,
"type": "number",
"description": "The BillRate.",
"format": "double",
"nullable": true
}
},
"additionalProperties": false,
"description": "The request model for adding an Adjustment to an Assignment."
},
"TwApi.Services.Assignments.API.Models.CreateAssignmentDirectHirePlacementFeeRequest": {
"required": [
"billingDate",
"isActive",
"rate"
],
"type": "object",
"properties": {
"billingDate": {
"type": "string",
"description": "The placement fee billig date.",
"format": "date-time"
},
"rate": {
"maximum": 49999999.99,
"minimum": -49999999.99,
"type": "number",
"description": "The placement fee rate.",
"format": "double"
},
"notes": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "The placement fee notes.",
"nullable": true
},
"isActive": {
"type": "boolean",
"description": "A flag determining whether a placement fee is active or not."
}
},
"additionalProperties": false,
"description": "A request to create placement fee for a direct hire assignment."
},
"TwApi.Services.Assignments.API.Models.CreateAssignmentRequest": {
"required": [
"assignmentRestrictionSessionId",
"employeeId",
"jobOrderId"
],
"type": "object",
"properties": {
"employeeId": {
"type": "integer",
"description": "The Id of the Employee to be assigned",
"format": "int64"
},
"jobOrderId": {
"type": "integer",
"description": "The Id of the Order to create the Assignment on.",
"format": "int64"
},
"startDate": {
"type": "string",
"description": "Optional start date of the Assignment. The Order start date will be used if not specified. \r\nThe date format is ISO 8601 YYYY-MM-DD.",
"format": "date-time",
"nullable": true
},
"assignmentRestrictionSessionId": {
"type": "string",
"description": "Assignment Restriction Sessions can be created with the Job Orders > Create Assignment Restriction Session endpoint. All results from the session\r\nmust be approved before the employee can be assigned.",
"format": "uuid"
},
"branchId": {
"type": "integer",
"description": "An override branch to create the assignment in (optional).",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to create an Assignment."
},
"TwApi.Services.Assignments.API.Models.CreateTimeclockPunchRequest": {
"required": [
"punchTime"
],
"type": "object",
"properties": {
"punchTime": {
"type": "string",
"description": "The date, time and UTC offset of the punch in ISO 8601 format. This should be the local time on the clock.",
"format": "date-time"
},
"longitude": {
"maximum": 180,
"minimum": -180,
"type": "number",
"description": "The Longitude of the location the punch took place. Required if GeoFencing is enabled.",
"format": "double",
"nullable": true
},
"latitude": {
"maximum": 90,
"minimum": -90,
"type": "number",
"description": "The Latitude of the location the punch took place. Required if GeoFencing is enabled.",
"format": "double",
"nullable": true
},
"faceVerificationBytes": {
"type": "string",
"description": "The image to be used for Face Verification if it is enabled.",
"format": "byte",
"nullable": true
},
"payCodeId": {
"type": "integer",
"description": "The Id of the Pay Code the punch should be recorded under. A list of pay codes can be found at the\r\nassignment/{assignmentId}/timeclock/payCodes endpoint.",
"format": "int32",
"nullable": true
},
"costCode": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "The Id of the Pay Code the punch should be recorded under. A list of cost codes can be found at the\r\nassignment/{assignmentId}/timeclock/costCodes endpoint.",
"nullable": true
},
"punchMetadata": {
"description": "Metadata about the punch. This is a dumping ground for data that might be useful later for purposes such as auditing.",
"nullable": true
},
"authMethodData": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "Authentication method used by this method to authenticate the employee.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to punch into the Assignment using a Timeclock."
},
"TwApi.Services.Assignments.API.Models.ExtendAssignmentRequest": {
"required": [
"startDate"
],
"type": "object",
"properties": {
"startDate": {
"type": "string",
"description": "The start date of the new assignment. The value must be equal to or greater than the assignment's start date. \r\nThe supplied start date dictates what the end date of the current assignment will be.\r\nWhen the current assignment's end date is greater than the supplied value, the end date will be changed to the day prior to the supplied start date.\r\nWhen the current assignment's end date is less than the supplied value, the end date will not be changed.\r\nWhen the current assignment's start date is equal to the supplied value, the end date will be changed to match the supplied start date. This would only occur if you were extending an assignment for an additional shift which requires a new assignment record due to changes in shift or job details.",
"format": "date-time"
},
"copyAssignmentAdjustments": {
"type": "boolean",
"description": "When true, any assignment adjustments will be copied to the new assignment.\r\nWhen false, the adjustments will not be copied to the new assignment.\r\nWhen null, the configuration 'CopyAssignmentAdjs' will be used.\r\nThe recommended value is null.",
"nullable": true
},
"copyAssignmentCustomData": {
"type": "boolean",
"description": "When true, all assignment custom data fields will be copied to the new assignment.\r\nWhen false, the custom data fields will not be copied to the new assignment.\r\nWhen null, the configuration 'CopyAsgCustomDataInExtendAssignment' will be used.\r\nThe recommended value is null.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Request criteria for Extend Assignment."
},
"TwApi.Services.Assignments.API.Models.UpdateAssignmentAccrualRequest": {
"required": [
"accrualId",
"isActive"
],
"type": "object",
"properties": {
"accrualId": {
"type": "string",
"description": "The Accrual Id",
"format": "uuid"
},
"isActive": {
"type": "boolean",
"description": "Indicates if the accrual is active."
}
},
"additionalProperties": false,
"description": "A request to update an accrual for an assignment."
},
"TwApi.Services.Assignments.API.Models.UpdateAssignmentAdjustmentRequest": {
"required": [
"adjustmentId",
"payCodeId"
],
"type": "object",
"properties": {
"adjustmentId": {
"type": "integer",
"description": "The Id of the Adjustment that is added to the Assignment.",
"format": "int32"
},
"payCodeId": {
"type": "integer",
"description": "The Id of the PayCode that is set when adding the Adjustment to the Assignment.",
"format": "int32"
},
"defaultPayRate": {
"maximum": 99999999.9999,
"minimum": -99999999.9999,
"type": "number",
"description": "The PayRate.",
"format": "double",
"nullable": true
},
"defaultBillRate": {
"maximum": 99999999.9999,
"minimum": -99999999.9999,
"type": "number",
"description": "The BillRate.",
"format": "double",
"nullable": true
}
},
"additionalProperties": false,
"description": "The request model for updating an Assignment Adjustment."
},
"TwApi.Services.Assignments.API.Models.UpdateAssignmentDirectHirePlacementFeeRequest": {
"required": [
"billingDate",
"isActive",
"rate"
],
"type": "object",
"properties": {
"billingDate": {
"type": "string",
"description": "The placement fee billing date.",
"format": "date-time"
},
"rate": {
"maximum": 49999999.99,
"minimum": -49999999.99,
"type": "number",
"description": "The placement fee rate.",
"format": "double"
},
"notes": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "The placement fee notes.",
"nullable": true
},
"isActive": {
"type": "boolean",
"description": "A flag determining whether a placement fee is active or not."
}
},
"additionalProperties": false,
"description": "A request to update placement fee for a direct hire assignment."
},
"TwApi.Services.Assignments.API.Models.UpdatedAssignmentDirectHireFinancialsRequest": {
"required": [
"directHireFeePercentage",
"fee",
"salary"
],
"type": "object",
"properties": {
"salary": {
"maximum": 49999999.99,
"minimum": -49999999.99,
"type": "number",
"description": "The direct hire salary of the assignment.",
"format": "double"
},
"fee": {
"maximum": 49999999.99,
"minimum": -49999999.99,
"type": "number",
"description": "The direct hire fee of the assignment.",
"format": "double"
},
"directHireFeePercentage": {
"maximum": 9.99999999,
"minimum": -9.99999999,
"type": "number",
"description": "The direct hire fee percentage of the assignment.",
"format": "double"
},
"purchaseOrderId": {
"type": "integer",
"description": "The specified Purchase Order must be set up on the customer. See Customers > Get Purchase Orders for a list of valid Purchase Orders.",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to update the direct hire financial information for an Assignment."
},
"TwApi.Services.Assignments.API.Models.UpdatedAssignmentFinancialsRequest": {
"required": [
"billRate",
"companyId",
"doubletimeBillRate",
"doubletimeFactor",
"doubletimePayRate",
"multiplierCodeId",
"overtimeBillRate",
"overtimeFactor",
"overtimePayRate",
"payRate",
"salaryBillRate",
"salaryPayRate",
"unitBillRate",
"unitPayRate",
"workerCompCodeId"
],
"type": "object",
"properties": {
"multiplierCodeId": {
"type": "integer",
"description": "The specified Multiplier Code must be set up in customer defaults. See Customers > Get Multiplier Codes for a list of valid Multiplier Codes.",
"format": "int32"
},
"overtimeFactor": {
"minimum": 0,
"type": "number",
"description": "Valid Overtime Factors can be found in the Overtime Factors Datalist.",
"format": "double"
},
"doubletimeFactor": {
"minimum": 0,
"type": "number",
"description": "The number the base rate should be multiplied by to calculate the doubletime rate.",
"format": "double"
},
"billRate": {
"type": "number",
"description": "The base bill rate for the assignment.",
"format": "double"
},
"overtimeBillRate": {
"type": "number",
"description": "The overtime bill rate for the assignment.",
"format": "double"
},
"doubletimeBillRate": {
"type": "number",
"description": "The doubletime bill rate for the assignment.",
"format": "double"
},
"unitBillRate": {
"type": "number",
"description": "The unit bill rate for the assignment.",
"format": "double"
},
"salaryBillRate": {
"type": "number",
"description": "The amount billed for a salaried employee.",
"format": "double"
},
"payRate": {
"type": "number",
"description": "The base pay rate for the assignment.",
"format": "double"
},
"overtimePayRate": {
"type": "number",
"description": "The overtime pay rate for the assignment.",
"format": "double"
},
"doubletimePayRate": {
"type": "number",
"description": "The doubletime pay rate for the assignment.",
"format": "double"
},
"unitPayRate": {
"type": "number",
"description": "The unit pay rate for the assignments created for the order.",
"format": "double"
},
"salaryPayRate": {
"type": "number",
"description": "The amount for a salaried employee is paid per pay period.",
"format": "double"
},
"workerCompCodeId": {
"type": "integer",
"description": "The specified Worker Comp Code must be set up in customer defaults. See Customers > Get Worker Comp Codes for a list of valid Worker Comp Codes.",
"format": "int32"
},
"payrollNote": {
"maxLength": 500,
"minLength": 0,
"type": "string",
"description": "Note to display to users during time entry.",
"nullable": true
},
"burdenTypeId": {
"type": "integer",
"description": "Valid Burden Types can be found in the Burden Types Datalist.",
"format": "int32",
"nullable": true
},
"companyId": {
"type": "integer",
"description": "Defines the company that the assignment is for. Valid Companies are Staffing Companies or Vendors found in the Companies Datalist.",
"format": "int32"
},
"purchaseOrderId": {
"type": "integer",
"description": "The specified Purchase Order must be set up on the customer. See Customers > Get Purchase Orders for a list of valid Purchase Orders.",
"format": "int32",
"nullable": true
},
"rateSheetId": {
"type": "string",
"description": "The Rate Sheet associated with the Assignment",
"format": "uuid",
"nullable": true
},
"subsPayRate": {
"type": "number",
"description": "The subs pay rate for the assignment.",
"format": "double",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to update the financial information for an Assignment."
},
"TwApi.Services.Assignments.Service.Commands.Accruals.AssignmentAccrualsList.Result": {
"type": "object",
"properties": {
"assignmentId": {
"type": "integer",
"format": "int64"
},
"assignmentAccrualId": {
"type": "string",
"format": "uuid"
},
"accrualId": {
"type": "string",
"format": "uuid"
},
"isActive": {
"type": "boolean"
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"accrualTypeId": {
"type": "string",
"format": "uuid"
},
"accrualType": {
"type": "string",
"nullable": true
},
"createdByServiceRepId": {
"type": "integer",
"format": "int32"
},
"createdByServiceRepName": {
"type": "string",
"nullable": true
},
"accrueOnDT": {
"type": "boolean"
},
"accrueOnOT": {
"type": "boolean"
},
"allowNegativeBalance": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Assignments.Service.Commands.Accruals.CreateAssignmentAccrual.Result": {
"type": "object",
"properties": {
"assignmentAccrualId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"TwApi.Services.Assignments.Service.Commands.Adjustments.AssignmentAdjustments.Result": {
"type": "object",
"properties": {
"assignmentAdjustmentId": {
"type": "integer",
"format": "int32"
},
"adjustmentId": {
"type": "integer",
"format": "int32"
},
"adjustment": {
"type": "string",
"nullable": true
},
"defaultPayRate": {
"type": "number",
"format": "double"
},
"defaultBillRate": {
"type": "number",
"format": "double"
},
"payCodeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"payCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Assignments.Service.Commands.Adjustments.CreateAssignmentAdjustment.Result": {
"type": "object",
"properties": {
"assignmentAdjustmentId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Assignments.Service.Commands.AssignmentAllocationQuery.Result": {
"type": "object",
"properties": {
"allocationsId": {
"type": "integer",
"format": "int64"
},
"assignmentId": {
"type": "integer",
"format": "int64"
},
"serviceRepId": {
"type": "integer",
"format": "int32"
},
"serviceRepName": {
"type": "string",
"nullable": true
},
"creditTypeId": {
"type": "integer",
"format": "int32"
},
"creditTypeName": {
"type": "string",
"nullable": true
},
"branchId": {
"type": "integer",
"format": "int32"
},
"branchName": {
"type": "string",
"nullable": true
},
"commissionBase": {
"type": "number",
"format": "double"
},
"dateCreated": {
"type": "string",
"format": "date-time"
},
"createdByServiceRepId": {
"type": "integer",
"format": "int32"
},
"createdByServiceRepName": {
"type": "string",
"nullable": true
},
"hasBeenAllocated": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Assignments.Service.Commands.AssignmentDetailsQuery.Result": {
"type": "object",
"properties": {
"assignmentId": {
"type": "integer",
"format": "int64"
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"employeeFirstName": {
"type": "string",
"nullable": true
},
"employeeLastName": {
"type": "string",
"nullable": true
},
"employeeMiddleName": {
"type": "string",
"nullable": true
},
"jobOrderId": {
"type": "integer",
"format": "int64"
},
"customerId": {
"type": "integer",
"format": "int64"
},
"customerName": {
"type": "string",
"nullable": true
},
"departmentName": {
"type": "string",
"nullable": true
},
"alternateAssignmentId": {
"type": "string",
"nullable": true
},
"temporaryPhoneNumber": {
"type": "string",
"nullable": true
},
"assignmentStatusId": {
"type": "integer",
"format": "int32"
},
"assignmentStatus": {
"type": "string",
"nullable": true
},
"activeStatus": {
"type": "integer",
"format": "int32"
},
"replacesAssignmentId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"replacesEmployeeId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"replacesEmployeeFirstName": {
"type": "string",
"nullable": true
},
"replacesEmployeeLastName": {
"type": "string",
"nullable": true
},
"replacesEmployeeMiddleName": {
"type": "string",
"nullable": true
},
"customerHasBlacklistedEmployee": {
"type": "boolean"
},
"employeeHasBlacklistedCustomer": {
"type": "boolean"
},
"jobTitleId": {
"type": "integer",
"format": "int32"
},
"jobTitle": {
"type": "string",
"nullable": true
},
"startDate": {
"type": "string",
"format": "date-time"
},
"originalStartDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"expectedEndDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"endDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"payRate": {
"type": "number",
"format": "double"
},
"billRate": {
"type": "number",
"format": "double"
},
"employerId": {
"type": "integer",
"format": "int32"
},
"employer": {
"type": "string",
"nullable": true
},
"companyId": {
"type": "integer",
"format": "int32"
},
"company": {
"type": "string",
"nullable": true
},
"assignmentRootGuid": {
"type": "string",
"format": "uuid"
},
"doNotAutoClose": {
"type": "boolean"
},
"serviceRepId": {
"type": "integer",
"format": "int32"
},
"serviceRep": {
"type": "string",
"nullable": true
},
"accountManagerServiceRepId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"accountManagerServiceRep": {
"type": "string",
"nullable": true
},
"createdByServiceRepId": {
"type": "integer",
"format": "int32"
},
"createdByServiceRep": {
"type": "string",
"nullable": true
},
"dateCreated": {
"type": "string",
"format": "date-time"
},
"salesTeamId": {
"type": "integer",
"format": "int32"
},
"salesTeam": {
"type": "string",
"nullable": true
},
"branchId": {
"type": "integer",
"format": "int32"
},
"branchName": {
"type": "string",
"nullable": true
},
"performanceNote": {
"type": "string",
"nullable": true
},
"isNonComparable": {
"type": "boolean"
},
"resetsAwrClock": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Assignments.Service.Commands.AssignmentDirectHireFinancials.Result": {
"type": "object",
"properties": {
"assignmentId": {
"type": "integer",
"format": "int64"
},
"salary": {
"type": "number",
"format": "double"
},
"fee": {
"type": "number",
"format": "double"
},
"directHireFeePercentage": {
"type": "number",
"format": "double",
"nullable": true
},
"purchaseOrderId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"purchaseOrder": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Assignments.Service.Commands.AssignmentDirectHirePlacementFeeDetails.Result": {
"type": "object",
"properties": {
"placementFeeId": {
"type": "string",
"format": "uuid"
},
"assignmentId": {
"type": "integer",
"format": "int64"
},
"active": {
"type": "boolean"
},
"rate": {
"type": "number",
"format": "double"
},
"startDate": {
"type": "string",
"format": "date-time"
},
"note": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Assignments.Service.Commands.AssignmentDirectHirePlacementFees.Result": {
"type": "object",
"properties": {
"placementFeeId": {
"type": "string",
"format": "uuid"
},
"assignmentId": {
"type": "integer",
"format": "int64"
},
"active": {
"type": "boolean"
},
"rate": {
"type": "number",
"format": "double"
},
"startDate": {
"type": "string",
"format": "date-time"
},
"note": {
"type": "string",
"nullable": true
},
"canEdit": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Assignments.Service.Commands.AssignmentFinancialsQuery.Result": {
"type": "object",
"properties": {
"assignmentId": {
"type": "integer",
"format": "int64"
},
"multiplierCodeId": {
"type": "integer",
"format": "int32"
},
"multiplierCode": {
"type": "string",
"nullable": true
},
"overtimeFactor": {
"type": "number",
"format": "double"
},
"doubletimeFactor": {
"type": "number",
"format": "double"
},
"billRate": {
"type": "number",
"format": "double"
},
"overtimeBillRate": {
"type": "number",
"format": "double"
},
"doubletimeBillRate": {
"type": "number",
"format": "double"
},
"unitBillRate": {
"type": "number",
"format": "double"
},
"salaryBillRate": {
"type": "number",
"format": "double"
},
"payRate": {
"type": "number",
"format": "double"
},
"overtimePayRate": {
"type": "number",
"format": "double"
},
"doubletimePayRate": {
"type": "number",
"format": "double"
},
"unitPayRate": {
"type": "number",
"format": "double"
},
"salaryPayRate": {
"type": "number",
"format": "double"
},
"workerCompCodeId": {
"type": "integer",
"format": "int32"
},
"workerCompCode": {
"type": "string",
"nullable": true
},
"isW2": {
"type": "boolean"
},
"payrollNote": {
"type": "string",
"nullable": true
},
"burdenTypeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"burdenType": {
"type": "string",
"nullable": true
},
"employerId": {
"type": "integer",
"format": "int32"
},
"employer": {
"type": "string",
"nullable": true
},
"companyId": {
"type": "integer",
"format": "int32"
},
"company": {
"type": "string",
"nullable": true
},
"purchaseOrderId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"purchaseOrder": {
"type": "string",
"nullable": true
},
"rateSheetId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"sutaJurisId": {
"type": "integer",
"format": "int32"
},
"sutaJuris": {
"type": "string",
"nullable": true
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"doNotGenerateCtxns": {
"type": "boolean"
},
"burdenRate": {
"type": "number",
"format": "double"
},
"subsPayRate": {
"type": "number",
"format": "double",
"nullable": true
},
"companyIsVendor": {
"type": "boolean",
"nullable": true
},
"assignmentRootGuid": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"TwApi.Services.Assignments.Service.Commands.AssignmentMatchingRateSheets.Result": {
"type": "object",
"properties": {
"matchingRateSheets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.RateSheets.Service.Commands.GetRateSheetMatchList.Result"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Assignments.Service.Commands.AssignmentStatusUpdateCommand.Result": {
"type": "object",
"properties": {
"statusChanged": {
"type": "boolean"
},
"additionalActionMessages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.StatusChange.AdditionalActionMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Assignments.Service.Commands.AssignmentSummaryQuery.Result": {
"type": "object",
"properties": {
"assignmentId": {
"type": "integer",
"format": "int64"
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"employeeFirstName": {
"type": "string",
"nullable": true
},
"employeeLastName": {
"type": "string",
"nullable": true
},
"employeeMiddleName": {
"type": "string",
"nullable": true
},
"employeePrimaryEmailAddress": {
"type": "string",
"nullable": true
},
"jobOrderId": {
"type": "integer",
"format": "int64"
},
"jobTitleId": {
"type": "integer",
"format": "int32"
},
"jobTitle": {
"type": "string",
"nullable": true
},
"customerId": {
"type": "integer",
"format": "int64"
},
"customerName": {
"type": "string",
"nullable": true
},
"customerPrimaryPhoneContactMethodId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"customerPrimaryPhoneContactMethod": {
"type": "string",
"nullable": true
},
"customerPrimaryPhoneContactMethodTypeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"customerPrimaryPhoneContactMethodType": {
"type": "string",
"nullable": true
},
"customerPrimaryEmailContactMethodId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"customerPrimaryEmailContactMethod": {
"type": "string",
"nullable": true
},
"customerPrimaryEmailContactMethodTypeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"customerPrimaryEmailContactMethodType": {
"type": "string",
"nullable": true
},
"departmentName": {
"type": "string",
"nullable": true
},
"branchId": {
"type": "integer",
"format": "int32"
},
"branchName": {
"type": "string",
"nullable": true
},
"activeStatus": {
"type": "integer",
"format": "int32"
},
"assignmentStatusId": {
"type": "integer",
"format": "int32"
},
"assignmentStatus": {
"type": "string",
"nullable": true
},
"startDate": {
"type": "string",
"format": "date-time"
},
"endDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"supervisorContactId": {
"type": "integer",
"format": "int32"
},
"supervisorFirstName": {
"type": "string",
"nullable": true
},
"supervisorLastName": {
"type": "string",
"nullable": true
},
"supervisorTitle": {
"type": "string",
"nullable": true
},
"supervisorPrimaryPhoneContactMethodId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"supervisorPrimaryPhoneContactMethod": {
"type": "string",
"nullable": true
},
"supervisorPrimaryPhoneContactMethodTypeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"supervisorPrimaryPhoneContactMethodType": {
"type": "string",
"nullable": true
},
"supervisorPrimaryEmailContactMethodId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"supervisorPrimaryEmailContactMethod": {
"type": "string",
"nullable": true
},
"supervisorPrimaryEmailContactMethodTypeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"supervisorPrimaryEmailContactMethodType": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Assignments.Service.Commands.CreateAssignmentAllocationCommand.Result": {
"type": "object",
"properties": {
"allocationsId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Assignments.Service.Commands.CreateAssignmentCommand.Result": {
"type": "object",
"properties": {
"assignmentId": {
"type": "integer",
"format": "int64"
}
},
"additionalProperties": false
},
"TwApi.Services.Assignments.Service.Commands.CreateAssignmentDirectHirePlacementFee.Result": {
"type": "object",
"properties": {
"placementFeeId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"TwApi.Services.Assignments.Service.Commands.ExtendAssignment.Result": {
"type": "object",
"properties": {
"assignmentId": {
"type": "integer",
"format": "int64"
}
},
"additionalProperties": false
},
"TwApi.Services.Contacts.API.Models.ContactInviteWebUserRequest": {
"required": [
"emailAddress",
"webCenterRoleId"
],
"type": "object",
"properties": {
"emailAddress": {
"minLength": 1,
"type": "string",
"description": "The email address of the user to invite to be a web user. If there is an existing email on file this will be ignored. If not a new email value will be saved as the email on file."
},
"webCenterRoleId": {
"type": "string",
"description": "The web center role of the invite.",
"format": "uuid"
}
},
"additionalProperties": false,
"description": "A request to invite a contact to be a web user."
},
"TwApi.Services.Contacts.API.Models.CreateContactInterestCodeRequest": {
"required": [
"interestCodeId"
],
"type": "object",
"properties": {
"interestCodeId": {
"type": "integer",
"description": "Valid Interest Codes can be found in the Interest Codes Datalist.",
"format": "int32"
},
"note": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "A field for notes.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to add an Interest Code to a Contact."
},
"TwApi.Services.Contacts.API.Models.CreateContactRequest": {
"type": "object",
"properties": {
"firstName": {
"maxLength": 25,
"minLength": 0,
"type": "string",
"description": "The contact's first name.",
"nullable": true
},
"lastName": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "The contact's last name.",
"nullable": true
},
"title": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "The contact's title.",
"nullable": true
},
"customerId": {
"type": "integer",
"description": "Optional parameter to specify a customer to associate this contact to.",
"format": "int64",
"nullable": true
},
"newCustomerName": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Optional parameter to create a new customer when creating this contact. If this is specified, CustomerId must not be specified.",
"nullable": true
},
"companyId": {
"type": "integer",
"description": "Optional parameter to specify a company to associate this contact to.",
"format": "int32",
"nullable": true
},
"newCompanyName": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Optional parameter to create a new company when creating this contact. If this is specified, CompanyId must not be specified.",
"nullable": true
},
"worksiteId": {
"type": "integer",
"description": "Optional parameter to associate the contact with a particular worksite. Maps back to addrId in database.",
"format": "int32",
"nullable": true
},
"copyAddressFromCustomer": {
"type": "boolean",
"description": "If set to true, the address for the contact will be copied from the customer specified in the CustomerId field."
},
"street1": {
"maxLength": 45,
"minLength": 0,
"type": "string",
"description": "This is the main street address. I.E. 1234 Main St.",
"nullable": true
},
"street2": {
"maxLength": 45,
"minLength": 0,
"type": "string",
"description": "This is the secondary part of the address reserved for things such as identifying suite or apartment numbers.",
"nullable": true
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "The city/municipality of the address.",
"nullable": true
},
"region": {
"maxLength": 5,
"minLength": 0,
"type": "string",
"description": "The state/region of the address.",
"nullable": true
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"type": "string",
"description": "The postal code of the address.",
"nullable": true
},
"countryCode": {
"type": "integer",
"description": "Contact's Country Code. Valid Country Codes can be found in the Country Codes Datalist.",
"format": "int32",
"nullable": true
},
"bypassAddressValidationService": {
"type": "boolean",
"description": "If true, address validation will be bypassed and the address will save as long as all other validation passes.\r\nDefaults to true."
},
"branchId": {
"type": "integer",
"description": "The Id of the branch the contact will be linked to. A list of branches can be found at the datalists/branches endpoint.",
"format": "int32",
"nullable": true
},
"contactStatusId": {
"type": "string",
"description": "Valid Contact Statuses can be found in the Contact Statuses Datalist. Maps back to status in database.",
"nullable": true
},
"officePhone": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "The phone number used to reach the contact at their office.",
"nullable": true
},
"officePhoneCountryCallingCode": {
"type": "integer",
"description": "Valid Country Calling Codes can be found in the Country Calling Codes Datalist.",
"format": "int32",
"nullable": true
},
"faxNumber": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "The fax number used to reach the contact at their office.",
"nullable": true
},
"faxNumberCountryCallingCode": {
"type": "integer",
"description": "Valid Country Calling Codes can be found in the Country Calling Codes Datalist.",
"format": "int32",
"nullable": true
},
"emailAddress": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "The email address used to reach the contact.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to create a Contact."
},
"TwApi.Services.Contacts.API.Models.CreateContactWebUserRequest": {
"required": [
"password",
"username"
],
"type": "object",
"properties": {
"username": {
"maxLength": 254,
"minLength": 0,
"type": "string",
"description": "The Web User's Username"
},
"password": {
"maxLength": 100,
"minLength": 7,
"type": "string",
"description": "The Password the Web User will use to login."
},
"automaticallyLinkProductInstances": {
"type": "boolean",
"description": "Optional Parameter.\r\nIf true, ProductInstanceId and RoleId parameters will be ignored and the Web User will be linked to product instances based on the Api User's current hierarchy.",
"nullable": true
},
"webCenterProductInstanceId": {
"type": "string",
"description": "The Product Instance Id for the Web Center instance the Web User will log into.\r\nA list of instances is available at Datalists/productInstances. Use the ProductId of 4 to get Web Center instances.",
"format": "uuid",
"nullable": true
},
"webCenterRoleId": {
"type": "string",
"description": "The Role Id for the user to use when logging into Web Center.\r\nUse the Contacts/{employeeId}/webUser/webCenter/availableRoles endpoint to get a list of available roles for a Contact.",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false,
"description": "A Request Passed into the API to initiate the creation of a Web User for a Contact"
},
"TwApi.Services.Contacts.API.Models.UpdateContactAddressRequest": {
"required": [
"countryCode",
"municipality",
"postalCode",
"region",
"street1"
],
"type": "object",
"properties": {
"bypassAddressValidationService": {
"type": "boolean",
"description": "If true, bypasses validating the address against the configured address validation service."
},
"street1": {
"maxLength": 45,
"minLength": 0,
"type": "string",
"description": "This is the main street address. I.E. 1234 Main St."
},
"street2": {
"maxLength": 45,
"minLength": 0,
"type": "string",
"description": "This is the secondary part of the address reserved for things such as identifying suite or apartment numbers.",
"nullable": true
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "The city/municipality of the address."
},
"region": {
"maxLength": 5,
"minLength": 0,
"type": "string",
"description": "The state/region of the address."
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"type": "string",
"description": "The postal code of the address."
},
"countryCode": {
"type": "integer",
"description": "Contact's Country Code. Valid Country Codes can be found in the Country Codes Datalist.",
"format": "int32"
}
},
"additionalProperties": false,
"description": "A request to update the Contact's address."
},
"TwApi.Services.Contacts.API.Models.UpdateContactInterestCodeRequest": {
"required": [
"interestCodeId"
],
"type": "object",
"properties": {
"interestCodeId": {
"type": "integer",
"description": "Valid Interest Codes can be found in the Interest Codes Datalist.",
"format": "int32"
},
"note": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "A field for notes.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to update an existing Interest Code on a Contact."
},
"TwApi.Services.Contacts.API.Models.UpdateContactInterestCodesRequest": {
"required": [
"interestCodes"
],
"type": "object",
"properties": {
"interestCodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Contacts.Service.Commands.InterestCodes.Models.ContactInterestCode"
},
"description": "The Contact's updated interest codes"
}
},
"additionalProperties": false,
"description": "A request to update a Contact's interest codes"
},
"TwApi.Services.Contacts.Service.Commands.ContactDetailsQuery.Result": {
"type": "object",
"properties": {
"contactId": {
"type": "integer",
"format": "int32"
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"nickname": {
"type": "string",
"nullable": true
},
"honorific": {
"type": "string",
"nullable": true
},
"birthday": {
"type": "string",
"nullable": true
},
"customerId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"customerName": {
"type": "string",
"nullable": true
},
"departmentName": {
"type": "string",
"nullable": true
},
"dateCreated": {
"type": "string",
"format": "date-time",
"nullable": true
},
"note": {
"type": "string",
"nullable": true
},
"contactStatusId": {
"type": "string",
"nullable": true
},
"contactStatus": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"branchId": {
"type": "integer",
"format": "int32"
},
"branchName": {
"type": "string",
"nullable": true
},
"address": {
"$ref": "#/components/schemas/TempWorks.TwApi.Common.Models.Address"
},
"worksiteId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"worksiteName": {
"type": "string",
"nullable": true
},
"worksiteAddress": {
"$ref": "#/components/schemas/TempWorks.TwApi.Common.Models.Address"
},
"howHeardOfId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"howHeardOf": {
"type": "string",
"nullable": true
},
"howHeardOfDetail": {
"type": "string",
"nullable": true
},
"companyId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"companyName": {
"type": "string",
"nullable": true
},
"companyTypeId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"companyType": {
"type": "string",
"nullable": true
},
"serviceRepId": {
"type": "integer",
"format": "int32"
},
"serviceRep": {
"type": "string",
"nullable": true
},
"employeeId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"employeeLastName": {
"type": "string",
"nullable": true
},
"employeeFirstName": {
"type": "string",
"nullable": true
},
"contactRootGuid": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"TwApi.Services.Contacts.Service.Commands.ContactStatusUpdateCommand.Result": {
"type": "object",
"properties": {
"statusChanged": {
"type": "boolean"
},
"additionalActionMessages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.StatusChange.AdditionalActionMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Contacts.Service.Commands.InterestCodes.ContactInterestCodesQuery.Result": {
"type": "object",
"properties": {
"contactInterestCodeGuid": {
"type": "string",
"format": "uuid"
},
"contactInterestCodeId": {
"type": "integer",
"format": "int32"
},
"interestCodeId": {
"type": "integer",
"format": "int32"
},
"interestCode": {
"type": "string",
"nullable": true
},
"note": {
"type": "string",
"nullable": true
},
"subCategoryId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"subCategory": {
"type": "string",
"nullable": true
},
"dateCreated": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"TwApi.Services.Contacts.Service.Commands.InterestCodes.CreateContactInterestCodeCommand.Result": {
"type": "object",
"properties": {
"contactInterestCodeId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Contacts.Service.Commands.InterestCodes.Models.ContactInterestCode": {
"type": "object",
"properties": {
"interestCodeId": {
"type": "integer",
"format": "int32"
},
"note": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.API.Models.AssignPurchaseOrderToRelatedEntitiesRequest": {
"required": [
"assignToAssignments",
"assignToJobOrders",
"assignToTimecards",
"updateChildDepartmentsRelatedEntities"
],
"type": "object",
"properties": {
"updateChildDepartmentsRelatedEntities": {
"type": "boolean",
"description": "If true, also assigns the PO to entities related to child departments."
},
"assignToJobOrders": {
"type": "boolean",
"description": "If true, assigns the PO to Job Orders for this customer. Only Job Orders with IsActive = 1 will be updated."
},
"assignToAssignments": {
"type": "boolean",
"description": "If true, assigns the PO to Assignments for this customer. Only Assignments with ActiveStatus = 1 will be updated."
},
"assignToTimecards": {
"type": "boolean",
"description": "If true, assigns the PO to current Timecards for this customer. Only Timecards with IsInvoicingComplete = 0 will be updated."
}
},
"additionalProperties": false,
"description": "A request to mass assign a Purchase Order to Job Orders, Assignments, and Timecards."
},
"TwApi.Services.Customers.API.Models.ChangeParentCustomerRequest": {
"required": [
"newParentCustomerId"
],
"type": "object",
"properties": {
"newParentCustomerId": {
"type": "integer",
"description": "Id of the new parent.",
"format": "int64"
}
},
"additionalProperties": false,
"description": "A request to change parent the parent customer Customer."
},
"TwApi.Services.Customers.API.Models.CreateCustomerAbsenceCandidateRequest": {
"required": [
"employeeId"
],
"type": "object",
"properties": {
"employeeId": {
"type": "integer",
"description": "The Id of the employee. A list of employees can be found at the search/employees endpoint.",
"format": "int64"
}
},
"additionalProperties": false,
"description": "A request to add an Employee as an absence candidate to the Customer."
},
"TwApi.Services.Customers.API.Models.CreateCustomerAccrualRequest": {
"required": [
"accrualId",
"applyToDepartments",
"isActive"
],
"type": "object",
"properties": {
"accrualId": {
"type": "string",
"description": "The Accrual Id",
"format": "uuid"
},
"isActive": {
"type": "boolean",
"description": "Indicates if the accrual is active."
},
"applyToDepartments": {
"type": "boolean",
"description": "Departments will inherit the default accruals of this customer when true."
}
},
"additionalProperties": false,
"description": "A request to create the defaults for the customer that are passed down to its child departments."
},
"TwApi.Services.Customers.API.Models.CreateCustomerDefaultJobDescriptionRequest": {
"required": [
"jobDescription",
"jobTitleId"
],
"type": "object",
"properties": {
"jobTitleId": {
"type": "integer",
"description": "The job title id (skill code id).",
"format": "int32"
},
"jobDescription": {
"maxLength": 4000,
"minLength": 0,
"type": "string",
"description": "This is the job description."
},
"publicJobTitle": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "This is the public job title.",
"nullable": true
},
"publicJobDescription": {
"maxLength": 8000,
"minLength": 0,
"type": "string",
"description": "This is the public job description.",
"nullable": true
},
"experienceSummary": {
"maxLength": 1000,
"minLength": 0,
"type": "string",
"description": "This is the experience summary.",
"nullable": true
},
"educationSummary": {
"maxLength": 1000,
"minLength": 0,
"type": "string",
"description": "This is the education summary.",
"nullable": true
},
"localizedPublicJobDescriptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.LocalizedPublicJobDescription"
},
"description": "The localized job descriptions model.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to create a new default job description."
},
"TwApi.Services.Customers.API.Models.CreateCustomerDefaultMultiplierCodeRequest": {
"required": [
"multiplierCodeId",
"priority"
],
"type": "object",
"properties": {
"multiplierCodeId": {
"type": "integer",
"description": "Id of the Multiplier Code. Valid Multiplier Codes and their Ids can be found in the Multiplier Codes Datalist.",
"format": "int32"
},
"priority": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer",
"description": "The priority is a positive integer used to order of the multiplier code list.\r\n The priority with the lowest value will be the default multiplier code applied to new orders and assignments.\r\n The list is ordered by the multiplier code if the priority is duplicated.",
"format": "int32"
}
},
"additionalProperties": false,
"description": "A request to add an Multiplier Code as a default for Job Orders belonging to the Customer."
},
"TwApi.Services.Customers.API.Models.CreateCustomerDefaultRequiredDocumentTypeRequest": {
"required": [
"requiredDocumentTypeId"
],
"type": "object",
"properties": {
"requiredDocumentTypeId": {
"type": "integer",
"description": "The required document type identifier.",
"format": "int32"
}
},
"additionalProperties": false,
"description": "A request to add a Required Document type as a default for a Customer."
},
"TwApi.Services.Customers.API.Models.CreateCustomerDefaultShiftRequest": {
"required": [
"endTime",
"isScheduledForFriday",
"isScheduledForMonday",
"isScheduledForSaturday",
"isScheduledForSunday",
"isScheduledForThursday",
"isScheduledForTuesday",
"isScheduledForWednesday",
"shift",
"startTime"
],
"type": "object",
"properties": {
"shift": {
"maxLength": 10,
"minLength": 0,
"type": "string",
"description": "The name of the shift."
},
"startTime": {
"type": "string",
"description": "The time of day the shift starts. Only the time portion is relevant.",
"format": "date-time"
},
"endTime": {
"type": "string",
"description": "The time of day the shift ends. Only the time portion is relevant.",
"format": "date-time"
},
"shiftNotes": {
"maxLength": 1000,
"minLength": 0,
"type": "string",
"description": "Notes about the shift.",
"nullable": true
},
"isScheduledForSunday": {
"type": "boolean",
"description": "Indicates whether or not employees working this shift work on Sunday."
},
"isScheduledForMonday": {
"type": "boolean",
"description": "Indicates whether or not employees working this shift work on Monday."
},
"isScheduledForTuesday": {
"type": "boolean",
"description": "Indicates whether or not employees working this shift work on Tuesday."
},
"isScheduledForWednesday": {
"type": "boolean",
"description": "Indicates whether or not employees working this shift work on Wednesday."
},
"isScheduledForThursday": {
"type": "boolean",
"description": "Indicates whether or not employees working this shift work on Thursday."
},
"isScheduledForFriday": {
"type": "boolean",
"description": "Indicates whether or not employees working this shift work on Friday."
},
"isScheduledForSaturday": {
"type": "boolean",
"description": "Indicates whether or not employees working this shift work on Saturday."
},
"minutesOfBreakPerDay": {
"minimum": 0,
"type": "number",
"description": "How many minutes of break each day do employees who work this shift receive.",
"format": "double"
},
"localizedShiftValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TempWorks.TwApi.Common.Models.LocalizedShiftValues"
},
"description": "Localized values about the shift.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to add an Shift as a default for Job Orders belonging to the Customer."
},
"TwApi.Services.Customers.API.Models.CreateCustomerDefaultWorkerCompCodeRequest": {
"required": [
"priority",
"workerCompCodeId"
],
"type": "object",
"properties": {
"workerCompCodeId": {
"type": "integer",
"description": "Id of the Worker Comp Code. Valid Worker Comp Codes and their Ids can be found in the Worker Comp Codes Datalist.",
"format": "int32"
},
"priority": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer",
"description": "The priority is a positive integer used to order of the worker comp code list.\r\n The priority with the lowest value will be the default worker comp code applied to new orders and assignments.\r\n The list is ordered by the worker comp code name if the priority is duplicated.",
"format": "int32"
}
},
"additionalProperties": false,
"description": "A request to add an Worker Comp Code as a default for Job Orders belonging to the Customer."
},
"TwApi.Services.Customers.API.Models.CreateCustomerDoNotAssignRequest": {
"type": "object",
"properties": {
"employeeId": {
"type": "integer",
"description": "The id of the employee which the customer requested not to be assigned to.",
"format": "int64"
},
"isInitiatedByCustomer": {
"type": "boolean",
"description": "Specifies whether the customer has initiated the \"do not assign\" restriction."
},
"isInitiatedByEmployee": {
"type": "boolean",
"description": "Specifies whether the employee has initiated the \"do not assign\" restriction."
},
"isForAllDepartments": {
"type": "boolean",
"description": "Specifies whether the \"do not assign\" restriction should apply to all departments of the customer."
},
"message": {
"type": "string",
"description": "The reason for the \"do not assign\" restriction.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request of a customer not to be assigned to an employee."
},
"TwApi.Services.Customers.API.Models.CreateCustomerInterestCodeRequest": {
"required": [
"interestCodeId",
"isRequired"
],
"type": "object",
"properties": {
"interestCodeId": {
"type": "integer",
"description": "Id for the Interest Code. Valid Interest Codes and their Ids can be found in the Interest Codes Datalist.",
"format": "int32"
},
"note": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "Notes about the interest code.",
"nullable": true
},
"isRequired": {
"type": "boolean",
"description": "If true, employees are required to have the same interest code on their profile to be placed on assignment for this customer."
}
},
"additionalProperties": false,
"description": "A request to add an Interest Code to the Customer."
},
"TwApi.Services.Customers.API.Models.CreateCustomerLineItemDetailRequest": {
"required": [
"invoiceLineItemDetailId"
],
"type": "object",
"properties": {
"invoiceLineItemDetailId": {
"minLength": 1,
"type": "string",
"description": "The Id of the detail to add. A list of details can be found at the datalists/invoiceLineItemDetails endpoint."
}
},
"additionalProperties": false,
"description": "A request to add a detail to each line item on an invoice."
},
"TwApi.Services.Customers.API.Models.CreateCustomerRequest": {
"required": [
"customerName"
],
"type": "object",
"properties": {
"customerName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "The name of the customer."
},
"departmentName": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Department should be provided. If not is will default to 'Primary'",
"nullable": true
},
"salesTeamId": {
"type": "integer",
"description": "Id of the Sales Team associated with this customer. Valid SalesTeamIds can be found in the Sales Teams datalist. Maps back to SalesTeamSid in the database.",
"format": "int32",
"nullable": true
},
"street1": {
"maxLength": 45,
"minLength": 0,
"type": "string",
"description": "This is the main street address. I.E. 1234 Main St.",
"nullable": true
},
"street2": {
"maxLength": 45,
"minLength": 0,
"type": "string",
"description": "This is the secondary part of the address reserved for things such as identifying suite or apartment numbers.",
"nullable": true
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "The city/municipality of the address.",
"nullable": true
},
"region": {
"maxLength": 5,
"minLength": 0,
"type": "string",
"description": "The state/region of the address.",
"nullable": true
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"type": "string",
"description": "The postal code of the address.",
"nullable": true
},
"bypassAddressValidationService": {
"type": "boolean",
"description": "If true, address validation will be bypassed and the address will save as long as all other validation passes.\r\nDefaults to true."
},
"worksiteId": {
"type": "integer",
"description": "The worksite to associate with this customer. Existing worksites can be found with the Get Worksites endpoint. A worksite will be automatically created for the customer if left blank. This value will default to the parent's worksite on departments if not defined. Maps back to addrId in the database.",
"format": "int32",
"nullable": true
},
"parentCustomerId": {
"type": "integer",
"description": "Id for the new customer's parent. Use when creating departments or subdepartments.",
"format": "int64",
"nullable": true
},
"officePhone": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "The main phone number used to contact customer's office.",
"nullable": true
},
"officePhoneCountryCallingCode": {
"type": "integer",
"description": "Country Calling Code for the Office Phone. Valid Country Calling Codes can be found in the Country Calling Codes Datalist.",
"format": "int32",
"nullable": true
},
"emailAddress": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "The main phone number used to contact the customer's office.",
"nullable": true
},
"branchId": {
"type": "integer",
"description": "Branch associated with the customer. Defaults to the user's current branch if not specified. Valid Branches can be found in the Branches datalist.",
"format": "int32",
"nullable": true
},
"employerId": {
"type": "integer",
"description": "Employer record associated with the customer. Valid Employers can be found in the Employers Datalist. Maps back to Einc in the database.",
"format": "int32",
"nullable": true
},
"paymentTermsCodeId": {
"type": "integer",
"description": "Customer's invoice payment terms. Valid Payment Terms can be found in the Payment Terms Datalist. Maps back to paymentTermsCode in the database.",
"format": "int32",
"nullable": true
},
"note": {
"maxLength": 4000,
"minLength": 0,
"type": "string",
"description": "Notes about the customer.",
"nullable": true
},
"countryCode": {
"type": "integer",
"description": "Customer's country code. Valid Country Codes can be found in the Country Codes Datalist.",
"format": "int32",
"nullable": true
},
"workerCompCodeId": {
"type": "integer",
"description": "Specifies a default Worker Comp Code for orders/assignments for this customer. If not specified, inherits the Worker Comp Code from the user's current branch. Valid Worker Comp Codes can be found in the Worker Comp Code Datalist.",
"format": "int32",
"nullable": true
},
"attentionTo": {
"maxLength": 75,
"minLength": 0,
"type": "string",
"description": "Maps back to attnTo in the database.",
"nullable": true
},
"accountManagerServiceRepId": {
"type": "integer",
"description": "Maps back to AccountManagerSrIdent in the database.",
"format": "int32",
"nullable": true
},
"hierId": {
"type": "integer",
"description": "Optional parameter to specify where in the database hierarchy a record will be inserted at.",
"format": "int32",
"nullable": true
},
"customerStatusId": {
"type": "string",
"description": "Optional Customer Status. Defaults to a configurable value if not specified. Valid Customer Statuses can be found in the Customer Status Datalist. Maps back to Status in the database.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to create a new Customer."
},
"TwApi.Services.Customers.API.Models.CreateCustomerSalesTaxRequest": {
"required": [
"salesTaxJurisdictionId"
],
"type": "object",
"properties": {
"salesTaxJurisdictionId": {
"type": "string",
"description": "Valid Sales Tax Jurisdictions can be found in the Sales Taxes Datalist. Use Customer PostalCode and Country to narrow down the list of Sales Taxes.",
"format": "uuid"
}
},
"additionalProperties": false,
"description": "A request to indicate that a Sales Tax should be collected for work performed at for the Customer."
},
"TwApi.Services.Customers.API.Models.CreateCustomerWorksiteNoticeToOwnerRequest": {
"required": [
"isPrivate",
"jobAmount",
"qualified"
],
"type": "object",
"properties": {
"qualified": {
"type": "boolean",
"description": ""
},
"isPrivate": {
"type": "boolean",
"description": ""
},
"jobAmount": {
"type": "number",
"description": "",
"format": "double"
},
"reasonCodeId": {
"type": "integer",
"description": "",
"format": "int32",
"nullable": true
},
"dateFiled": {
"type": "string",
"description": "",
"format": "date-time",
"nullable": true
},
"dateReleased": {
"type": "string",
"description": "",
"format": "date-time",
"nullable": true
},
"notes": {
"type": "string",
"description": "",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to create the Notice To Owner for the customer worksite."
},
"TwApi.Services.Customers.API.Models.CreateDepartmentRequest": {
"required": [
"departmentName"
],
"type": "object",
"properties": {
"departmentName": {
"minLength": 1,
"type": "string",
"description": "The name of the new department."
},
"worksiteId": {
"type": "integer",
"description": "Id of the default worksite for the new department. Use Get Worksites to get a list of available worksites for the customer. If not specified, inherits the default worksite of the parent.",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to create a new Department under the current Customer."
},
"TwApi.Services.Customers.API.Models.CreatePurchaseOrderRequest": {
"required": [
"appliesToChildDepartments",
"isActive",
"purchaseOrderNumber",
"purchaseOrderValue"
],
"type": "object",
"properties": {
"purchaseOrderNumber": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "The purchase order number."
},
"purchaseOrderValue": {
"minimum": 0,
"type": "number",
"description": "The amount of money available to the purchase order.",
"format": "double"
},
"endDate": {
"type": "string",
"description": "The date the purchase order ends/expires.\r\nThe date format is ISO 8601 YYYY-MM-DD.",
"format": "date-time",
"nullable": true
},
"appliesToChildDepartments": {
"type": "boolean",
"description": "Indicates whether or not child departments also have access to this purchase order."
},
"isActive": {
"type": "boolean",
"description": "Indicates whether or not the purchase order is still active for use."
}
},
"additionalProperties": false,
"description": "A request to create a Purchase Order."
},
"TwApi.Services.Customers.API.Models.CreateWorksiteRequest": {
"required": [
"bypassAddressValidationService",
"countryCode",
"municipality",
"postalCode",
"region",
"street1",
"taxRegion",
"worksiteName"
],
"type": "object",
"properties": {
"worksiteName": {
"maxLength": 100,
"minLength": 0,
"type": "string",
"description": "Maps back to AddressDesc in the database."
},
"bypassAddressValidationService": {
"type": "boolean",
"description": "If true, address validation will be bypassed and the address will save as long as all other validation passes."
},
"attentionTo": {
"maxLength": 75,
"minLength": 0,
"type": "string",
"description": "Maps back to AddrAttnTo in the database.",
"nullable": true
},
"street1": {
"maxLength": 45,
"minLength": 0,
"type": "string",
"description": "This is the main street address. I.E. 1234 Main St."
},
"street2": {
"maxLength": 45,
"minLength": 0,
"type": "string",
"description": "This is the secondary part of the address reserved for things such as identifying suite or apartment numbers.",
"nullable": true
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "The city/municipality of the address."
},
"region": {
"maxLength": 5,
"minLength": 0,
"type": "string",
"description": "The state/region of the address."
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"type": "string",
"description": "The postal code of the address."
},
"countryCode": {
"type": "integer",
"description": "Worksite Country Code. Valid Country Codes can be found in the Country Codes Datalist.",
"format": "int32"
},
"countyId": {
"type": "integer",
"description": "Maps back to CountyCode in the database.",
"format": "int32",
"nullable": true
},
"municipalityId": {
"type": "integer",
"description": "Maps back to CityCode in the database.",
"format": "int32",
"nullable": true
},
"schoolDistrictId": {
"type": "integer",
"description": "Maps back to SchoolDistrictCode in the database.",
"format": "int32",
"nullable": true
},
"taxRegion": {
"maxLength": 5,
"minLength": 0,
"type": "string",
"description": "Worksite Tax Region. Valid Regions can be found in the Regions Datalist. Gets converted and mapped back to\r\nStateCompatibleJuris in the database."
},
"taxMunicipalityJurisdictionId": {
"type": "integer",
"description": "Defines which municipality tax (if any) applies to this worksite. Valid Municipality Tax Jurisdictions can be found in the\r\nMunicipality Income Tax Jurisdictions Datalist. Use TaxRegion and Municipality name to filter results. Maps back to\r\nCityJurisId in the database.",
"format": "int32",
"nullable": true
},
"isExemptFromMunicipalityTax": {
"type": "boolean",
"description": "Maps back to CityTaxExempt in the database."
},
"taxCountyJurisdictionId": {
"type": "integer",
"description": "Defines which county tax (if any) applies to this worksite. Valid County Tax Jurisdictions can be found in the County Income\r\nTax Jurisdictions Datalist. Use TaxRegion and County name to filter results. Maps back to CountyJurisId in the database.",
"format": "int32",
"nullable": true
},
"isExemptFromCountyTax": {
"type": "boolean",
"description": "Indicates whether or not the worksite is exempt from county taxes."
},
"taxSchoolDistrictJurisdictionId": {
"type": "integer",
"description": "Defines which school district tax (if any) applies to this worksite. Valid School District Tax Jurisdictions can be found in the\r\nSchool District Income Tax Jurisdictions Datalist. Use TaxRegion and School District name to filter results. Maps back to\r\nSchoolJurisId in the database.",
"format": "int32",
"nullable": true
},
"isExemptFromSchoolDistrictTax": {
"type": "boolean",
"description": "Indicates whether or not the worksite is exempt from school district taxes."
},
"pennsylvaniaLocalServiceTaxId": {
"type": "string",
"description": "The Id of the Pennsylvania Local Service Tax that applies to this worksite. Valid values can be found at the\r\ndatalists/pennsylvaniaLocalServiceTaxes endpoint.",
"format": "uuid",
"nullable": true
},
"directions": {
"maxLength": 1000,
"minLength": 0,
"type": "string",
"description": "Maps back to Directions1 in the database.",
"nullable": true
},
"dressCode": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "A place to detail the worksite's dress code.",
"nullable": true
},
"isPublicTransportationAccessible": {
"type": "boolean",
"description": "Indicates whether or not the worksite can be reached by public transportation.",
"nullable": true
},
"timeClockTimeZoneId": {
"type": "string",
"description": "Defines the Time Zone that timeclocks at this worksite are in. Valid Time Zones can be found in the Time Clock Time Zones Datalist.",
"format": "uuid",
"nullable": true
},
"isDaylightSavingsTimeObserved": {
"type": "boolean",
"description": "Indicates whether or not the worksite is in a location that observes daylight savings time."
},
"salesTaxJurisdictionIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "A list of Sales Taxes applicable to this worksite. Sales Taxes need to be set up on the customer as well. See Customer > Get Sales Taxes for a list of available Sales Taxes. Maps back to the SalesTaxJurisdictionGUID column in dbo.CustomerSalesTaxJurisdiction.",
"nullable": true
},
"accrualId": {
"type": "string",
"description": "Accrual override for the worksite",
"format": "uuid",
"nullable": true
},
"psdCode": {
"type": "string",
"description": "Political Subdivision Code - Exclusive to Pennsylvania. 6 digit code that identifies municipalities in Pennsylvania and Pennsylvania alone.",
"nullable": true
},
"isTimeClockEnabled": {
"type": "boolean",
"description": "Indicates if the Time Clock should be enabled."
},
"applyTimeClockToExistingJobOrders": {
"type": "boolean",
"description": "Indicates if the IsTimeClockEnabled property should also be set on all related Job Orders."
},
"localizedWorksiteDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TempWorks.TwApi.Common.Models.LocalizedWorksiteDetails"
},
"description": "The localized worksite directions and dress code.",
"nullable": true
},
"remoteWorkStatusId": {
"type": "integer",
"description": "The status of the worksite. Remote/Not Remote.",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to create a Worksite."
},
"TwApi.Services.Customers.API.Models.CreateWorksiteSalesTaxRequest": {
"required": [
"salesTaxJurisdictionId"
],
"type": "object",
"properties": {
"salesTaxJurisdictionId": {
"type": "string",
"description": "The Sales Tax to add to the worksite. Sales Taxes need to be set up on the customer as well. See Customer > Get Sales Taxes for a list of available Sales Taxes. Compare to Sales Taxes Datalist filtered by worksite PostalCode and CountryCode to find valid options.",
"format": "uuid"
}
},
"additionalProperties": false,
"description": "A request to indicate that a Sales Tax should be collected for work performed at a Worksite."
},
"TwApi.Services.Customers.API.Models.CustomerAbsenceReasonRequest": {
"required": [
"absenceReason",
"active"
],
"type": "object",
"properties": {
"absenceReason": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "The reason for the absence."
},
"active": {
"type": "boolean",
"description": "Whether or not the reason can be used."
}
},
"additionalProperties": false,
"description": "A request to update or create an absence reason for a Customer."
},
"TwApi.Services.Customers.API.Models.CustomerCompanyRequest": {
"required": [
"vendorCompanyId"
],
"type": "object",
"properties": {
"vendorCompanyId": {
"type": "integer",
"description": "Company id to add to the customer companies.",
"format": "int32"
},
"jobTitleId": {
"type": "integer",
"description": "Job title Id for the customer company.",
"format": "int32",
"nullable": true
},
"orderDelayInHours": {
"maximum": 8760,
"minimum": 0,
"type": "number",
"description": "Order delay in hours.",
"format": "double",
"nullable": true
},
"maxCandidatesPerReq": {
"maximum": 10000,
"minimum": 0,
"type": "integer",
"description": "Max candidates per request.",
"format": "int32",
"nullable": true
},
"jobOrderTypeIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "Job Order Type Ids.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to create/update a customer company (vendor)."
},
"TwApi.Services.Customers.API.Models.CustomerContactRoleCreateRequest": {
"required": [
"contactId",
"contactRoleId"
],
"type": "object",
"properties": {
"contactId": {
"type": "integer",
"description": "Valid ContactIds can be found at the customer/{id}/contacts endpoint.",
"format": "int32"
},
"contactRoleId": {
"type": "integer",
"description": "Valid ContactRoleId values can be found at the datalists/contactroles endpoint.",
"format": "int32"
},
"updateJobOrders": {
"type": "boolean",
"description": "If set to true, the contact will be added from active job orders associated with the customer. If set to true in conjunction \r\nwith UpdateDepartments, the contact will be added from all job orders belonging to the departments as well."
},
"updateDepartments": {
"type": "boolean",
"description": "If set to true, the contact will be removed from active departments associated with the customer."
},
"conflictResolutionApproach": {
"$ref": "#/components/schemas/TwApi.Common.Enums.CustomerRoleConflictResolutionApproach"
},
"includeInactiveOrders": {
"type": "boolean",
"description": "If set to true, the set of orders updated will no longer be restricted to just active orders. Inactive orders will have their contact roles updated as well."
},
"includeInactiveDepartments": {
"type": "boolean",
"description": "If set to true, the set of departments updated will no longer be restricted to just active orders. Inactive departments will have their contact roles updated as well."
}
},
"additionalProperties": false,
"description": "A request to specify a contact as performing a certain role at a Customer."
},
"TwApi.Services.Customers.API.Models.UpdateCustomerAccrualRequest": {
"required": [
"accrualId",
"applyToDepartments",
"isActive"
],
"type": "object",
"properties": {
"accrualId": {
"type": "string",
"description": "The Accrual Id",
"format": "uuid"
},
"isActive": {
"type": "boolean",
"description": "Indicates if the accrual is active."
},
"applyToDepartments": {
"type": "boolean",
"description": "Departments will inherit the default accruals of this customer when true."
}
},
"additionalProperties": false,
"description": "A request to update the defaults for the customer that are passed down to its child departments."
},
"TwApi.Services.Customers.API.Models.UpdateCustomerAddressRequest": {
"required": [
"countryCode",
"municipality",
"postalCode",
"region",
"street1"
],
"type": "object",
"properties": {
"bypassAddressValidationService": {
"type": "boolean",
"description": "If true, the address will not be validated against the United States Postal Service's address database."
},
"street1": {
"maxLength": 45,
"minLength": 0,
"type": "string",
"description": "This is the main street address. I.E. 1234 Main St."
},
"street2": {
"maxLength": 45,
"minLength": 0,
"type": "string",
"description": "This is the secondary part of the address reserved for things such as identifying suite or apartment numbers.",
"nullable": true
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "The city/municipality of the address."
},
"region": {
"maxLength": 5,
"minLength": 0,
"type": "string",
"description": "The state/region of the address."
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"type": "string",
"description": "The postal code of the address."
},
"countryCode": {
"type": "integer",
"description": "Customer's Country Code. Valid Country Codes can be found in the Country Codes Datalist.",
"format": "int32"
}
},
"additionalProperties": false,
"description": "A request to update a Customer's address."
},
"TwApi.Services.Customers.API.Models.UpdateCustomerBillingAddressRequest": {
"required": [
"countryCode"
],
"type": "object",
"properties": {
"bypassAddressValidationService": {
"type": "boolean",
"description": "If true, the address will not be validated against the United States Postal Service's address database."
},
"attentionTo": {
"maxLength": 75,
"minLength": 0,
"type": "string",
"description": "Maps back to AddrAttnTo in the database.",
"nullable": true
},
"street1": {
"maxLength": 45,
"minLength": 0,
"type": "string",
"description": "This is the main street address. I.E. 1234 Main St.",
"nullable": true
},
"street2": {
"maxLength": 45,
"minLength": 0,
"type": "string",
"description": "This is the secondary part of the address reserved for things such as identifying suite or apartment numbers.",
"nullable": true
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "The city/municipality of the address.",
"nullable": true
},
"region": {
"maxLength": 5,
"minLength": 0,
"type": "string",
"description": "The state/region of the address.",
"nullable": true
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"type": "string",
"description": "The postal code of the address.",
"nullable": true
},
"countryCode": {
"type": "integer",
"description": "Customer's Country Code. Valid Country Codes can be found in the Country Codes Datalist.",
"format": "int32"
}
},
"additionalProperties": false,
"description": "A request to update a Customer's billing address."
},
"TwApi.Services.Customers.API.Models.UpdateCustomerBillingSetupRequest": {
"required": [
"billingFrequencyId",
"consolidateInvoicingWithParent",
"currencyId",
"invoiceEmailTemplateId",
"invoiceRecipients",
"invoiceReportId",
"invoicingMethodId",
"splitInvoicesByAssignment",
"splitInvoicesByBranch",
"splitInvoicesByCostCenter",
"splitInvoicesByDepartment",
"splitInvoicesByDepartmentAddress",
"splitInvoicesByDivision",
"splitInvoicesByEmployee",
"splitInvoicesByJobOrder",
"splitInvoicesByJobTitle",
"splitInvoicesByPayCode",
"splitInvoicesByPurchaseOrder",
"splitInvoicesByShift",
"splitInvoicesBySubEntity",
"splitInvoicesBySupervisor",
"splitInvoicesByWeekEndDate",
"splitInvoicesByWorksite"
],
"type": "object",
"properties": {
"consolidateInvoicingWithParent": {
"type": "boolean",
"description": "If true, any invoicing for this customer will be consolidated with the parent customer's invoices."
},
"billingFrequencyId": {
"type": "string",
"description": "How often this customer is invoiced. Valid Billing Frequencies can be found in the Billing Frequencies Datalist.",
"format": "uuid"
},
"monthlyBillingCycleId": {
"type": "integer",
"description": "For biweekly/monthly invoicing - defines which week the customer should be billed. Valid Monthly Bill Cycle Ids can be found in\r\nthe Monthly Bill Cycles Datalist.",
"format": "int32",
"nullable": true
},
"invoiceNotes": {
"maxLength": 1000,
"minLength": 0,
"type": "string",
"description": "Notes to include on invoices.",
"nullable": true
},
"invoiceReportId": {
"type": "string",
"description": "The Id of the Report to be used when generating invoices. Valid reports can be found at the datalists/invoiceReports endpoint.",
"format": "uuid"
},
"invoiceEmailTemplateId": {
"type": "string",
"description": "The Id of the email template to use when sending out invoices. Valid templates can be found at the datalists/invoiceEmailTemplates\r\nendpoint.",
"format": "uuid"
},
"invoicingMethodId": {
"type": "integer",
"description": "The Id of the invoicing method to use. Valid methods can be found at the datalists/invoicingMethods endpoint.",
"format": "int32"
},
"currencyId": {
"type": "integer",
"description": "The Id of the currency to use. Valid methods can be found at the datalists/currencies endpoint.",
"format": "int32"
},
"invoiceHandlingCode": {
"type": "integer",
"description": "The code of the invoice handling to use. Valid methods can be found at the datalists/invoiceHandling endpoint.",
"format": "int32",
"nullable": true
},
"invoiceCCEmailAddress": {
"maxLength": 1000,
"minLength": 0,
"type": "string",
"description": "The CC email address to use when sending out invoices.",
"nullable": true
},
"splitInvoicesByAssignment": {
"type": "boolean",
"description": "If set to true, an invoice will be generated for each assignment in combination with other splits."
},
"splitInvoicesByBranch": {
"type": "boolean",
"description": "If set to true, an invoice will be generated for each branch in combination with other splits."
},
"splitInvoicesByCostCenter": {
"type": "boolean",
"description": "If set to true, an invoice will be generated for each cost center in combination with other splits."
},
"splitInvoicesByDepartment": {
"type": "boolean",
"description": "If set to true, an invoice will be generated for each department in combination with other splits."
},
"splitInvoicesByDivision": {
"type": "boolean",
"description": "If set to true, an invoice will be generated for each division in combination with other splits."
},
"splitInvoicesByEmployee": {
"type": "boolean",
"description": "If set to true, an invoice will be generated for each employee in combination with other splits."
},
"splitInvoicesByJobOrder": {
"type": "boolean",
"description": "If set to true, an invoice will be generated for each job order in combination with other splits."
},
"splitInvoicesByJobTitle": {
"type": "boolean",
"description": "If set to true, an invoice will be generated for each job title in combination with other splits."
},
"splitInvoicesByPayCode": {
"type": "boolean",
"description": "If set to true, an invoice will be generated for each pay code in combination with other splits."
},
"splitInvoicesByPurchaseOrder": {
"type": "boolean",
"description": "If set to true, an invoice will be generated for each purchase order in combination with other splits."
},
"splitInvoicesByShift": {
"type": "boolean",
"description": "If set to true, an invoice will be generated for each shift in combination with other splits."
},
"splitInvoicesBySubEntity": {
"type": "boolean",
"description": "If set to true, an invoice will be generated for each sub entity in combination with other splits."
},
"splitInvoicesBySupervisor": {
"type": "boolean",
"description": "If set to true, an invoice will be generated for each supervisor in combination with other splits."
},
"splitInvoicesByWeekEndDate": {
"type": "boolean",
"description": "If set to true, an invoice will be generated for each weekend date in combination with other splits."
},
"splitInvoicesByWorksite": {
"type": "boolean",
"description": "If set to true, an invoice will be generated for each worksite in combination with other splits."
},
"splitInvoicesByDepartmentAddress": {
"type": "boolean",
"description": "If set to true, an invoice will be generated for each department address in combination with other splits."
},
"invoiceRecipients": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.InvoiceRecipientForEdit"
},
"description": "A list of invoice recipients. There must be at least one invoice recipient if the InvoiceMethodId uses email."
}
},
"additionalProperties": false,
"description": "A request to update invoicing information for the Customer."
},
"TwApi.Services.Customers.API.Models.UpdateCustomerCreditAndPayRollSetupRequest": {
"required": [
"creditLimit",
"overTimePlanId",
"paymentTermsCodeId",
"payPeriods",
"weekEndsOn",
"workerCompCodeId"
],
"type": "object",
"properties": {
"creditLimit": {
"type": "number",
"description": "Credit limit set for customer.",
"format": "double"
},
"creditAnalystServiceRepId": {
"type": "integer",
"description": "Credit last checked by",
"format": "int32",
"nullable": true
},
"creditCheckDate": {
"type": "string",
"description": "Last date credit was checked",
"format": "date-time",
"nullable": true
},
"creditComment": {
"maxLength": 100,
"type": "string",
"description": "Credit check comment",
"nullable": true
},
"paymentTermsCodeId": {
"type": "integer",
"description": "The id of the payment terms code. List of valid values can be found in the payment terms datalist.",
"format": "int32"
},
"holdCode": {
"maxLength": 10,
"type": "string",
"description": "Hold code",
"nullable": true
},
"customerTypeId": {
"type": "integer",
"description": "Customer type",
"format": "int32",
"nullable": true
},
"payPeriods": {
"type": "integer",
"description": "The number of pay periods in a year for this customer.",
"format": "int32"
},
"workerCompCodeId": {
"type": "integer",
"description": "Workers compensation code",
"format": "int32"
},
"checkDelivery": {
"maxLength": 25,
"type": "string",
"description": "Check delivery method",
"nullable": true
},
"mileageRate": {
"type": "number",
"description": "Amount to reimburse per mile for mileage expenses.",
"format": "double",
"nullable": true
},
"weekEndsOn": {
"minLength": 1,
"type": "string",
"description": "The week end day setup on the customer. Should default to Sunday if nothing is provided in the defaults."
},
"overTimePlanId": {
"type": "integer",
"description": "Over time plan",
"format": "int32"
},
"monthlyPayCycleId": {
"type": "integer",
"description": "Customer monthly pay cycle type",
"format": "int32",
"nullable": true
},
"payrollNote": {
"maxLength": 500,
"type": "string",
"description": "Payroll note",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to update a Customer's Credit and Payrol Information."
},
"TwApi.Services.Customers.API.Models.UpdateCustomerDefaultJobDescriptionRequest": {
"required": [
"jobDescription",
"jobTitleId"
],
"type": "object",
"properties": {
"jobTitleId": {
"type": "integer",
"description": "The job title id (skill code id).",
"format": "int32"
},
"jobDescription": {
"maxLength": 4000,
"minLength": 0,
"type": "string",
"description": "The job description."
},
"publicJobTitle": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "The public job title.",
"nullable": true
},
"publicJobDescription": {
"maxLength": 8000,
"minLength": 0,
"type": "string",
"description": "The public job description.",
"nullable": true
},
"experienceSummary": {
"maxLength": 1000,
"minLength": 0,
"type": "string",
"description": "The experience summary.",
"nullable": true
},
"educationSummary": {
"maxLength": 1000,
"minLength": 0,
"type": "string",
"description": "The education summary.",
"nullable": true
},
"localizedPublicJobDescriptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.LocalizedPublicJobDescription"
},
"description": "The localized job descriptions model.",
"nullable": true
}
},
"additionalProperties": false,
"description": "The request model to update a default job description."
},
"TwApi.Services.Customers.API.Models.UpdateCustomerDefaultMultiplierCodeRequest": {
"required": [
"multiplierCodeId",
"priority"
],
"type": "object",
"properties": {
"multiplierCodeId": {
"type": "integer",
"description": "Id of the Multiplier Code. Valid Multiplier Codes and their Ids can be found in the Multiplier Codes Datalist.",
"format": "int32"
},
"priority": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer",
"description": "The priority is a positive integer used to order of the multiplier code list.\r\n The priority with the lowest value will be the default multiplier code applied to new orders and assignments.\r\n The list is ordered by the multiplier code if the priority is duplicated.",
"format": "int32"
}
},
"additionalProperties": false,
"description": "A request to update a Default Multiplier Code for the Customer."
},
"TwApi.Services.Customers.API.Models.UpdateCustomerDefaultRequiredDocumentTypeRequest": {
"required": [
"isActive",
"isRequired"
],
"type": "object",
"properties": {
"notes": {
"maxLength": 1000,
"minLength": 0,
"type": "string",
"description": "The notes associated with the customer default required document type.",
"nullable": true
},
"isRequired": {
"type": "boolean",
"description": "Indicates if the customer default required document type is required."
},
"isActive": {
"type": "boolean",
"description": "Indicates if the customer default required document type is active."
}
},
"additionalProperties": false,
"description": "A request to update the passed customer default required document type."
},
"TwApi.Services.Customers.API.Models.UpdateCustomerDefaultShiftRequest": {
"required": [
"endTime",
"isScheduledForFriday",
"isScheduledForMonday",
"isScheduledForSaturday",
"isScheduledForSunday",
"isScheduledForThursday",
"isScheduledForTuesday",
"isScheduledForWednesday",
"shift",
"startTime"
],
"type": "object",
"properties": {
"shift": {
"maxLength": 10,
"minLength": 0,
"type": "string",
"description": "The name of the shift."
},
"startTime": {
"type": "string",
"description": "The time of day the shift starts. Only the time portion is relevant.",
"format": "date-time"
},
"endTime": {
"type": "string",
"description": "The time of day the shift ends. Only the time portion is relevant.",
"format": "date-time"
},
"shiftNotes": {
"maxLength": 1000,
"minLength": 0,
"type": "string",
"description": "Notes about the shift.",
"nullable": true
},
"isScheduledForSunday": {
"type": "boolean",
"description": "Indicates whether or not employees working this shift work on Sunday."
},
"isScheduledForMonday": {
"type": "boolean",
"description": "Indicates whether or not employees working this shift work on Monday."
},
"isScheduledForTuesday": {
"type": "boolean",
"description": "Indicates whether or not employees working this shift work on Tuesday."
},
"isScheduledForWednesday": {
"type": "boolean",
"description": "Indicates whether or not employees working this shift work on Wednesday."
},
"isScheduledForThursday": {
"type": "boolean",
"description": "Indicates whether or not employees working this shift work on Thursday."
},
"isScheduledForFriday": {
"type": "boolean",
"description": "Indicates whether or not employees working this shift work on Friday."
},
"isScheduledForSaturday": {
"type": "boolean",
"description": "Indicates whether or not employees working this shift work on Saturday."
},
"minutesOfBreakPerDay": {
"minimum": 0,
"type": "number",
"description": "How many minutes of break each day do employees who work this shift receive.",
"format": "double"
},
"localizedShiftValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TempWorks.TwApi.Common.Models.LocalizedShiftValues"
},
"description": "Localized values about the shift.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to update an existing Default Shift on the Customer."
},
"TwApi.Services.Customers.API.Models.UpdateCustomerDefaultWorkerCompCodeRequest": {
"required": [
"priority",
"workerCompCodeId"
],
"type": "object",
"properties": {
"workerCompCodeId": {
"type": "integer",
"description": "Id of the Worker Comp Code. Valid Worker Comp Codes and their Ids can be found in the Worker Comp Codes Datalist.",
"format": "int32"
},
"priority": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer",
"description": "The priority is a positive integer used to order of the worker comp code list.\r\n The priority with the lowest value will be the default worker comp code applied to new orders and assignments.\r\n The list is ordered by the worker comp code name if the priority is duplicated.",
"format": "int32"
}
},
"additionalProperties": false,
"description": "A request to update an existing Default Worker Comp Code on the Customer."
},
"TwApi.Services.Customers.API.Models.UpdateCustomerDefaultsSettingsRequest": {
"required": [
"applyMultiplierCodesToDepartments",
"applyShiftsToDepartments",
"applyWorkerCompCodesToDepartments"
],
"type": "object",
"properties": {
"applyMultiplierCodesToDepartments": {
"type": "boolean",
"description": "Departments will inherit the default multiplier codes of this customer when true."
},
"applyShiftsToDepartments": {
"type": "boolean",
"description": "Departments will inherit the default shifts of this customer when true."
},
"applyWorkerCompCodesToDepartments": {
"type": "boolean",
"description": "Departments will inherit the default workers comp codes of this customer when true."
},
"applyRequiredDocumentsToDepartments": {
"type": "boolean",
"description": "Departments will inherit the default required documents of this customer when true.",
"nullable": true
},
"applyDefaultJobDescriptionToDepartments": {
"type": "boolean",
"description": "Departments will inherit the default job description of this customer when true.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to update what defaults for the customer are passed down to its child departments."
},
"TwApi.Services.Customers.API.Models.UpdateCustomerInterestCodeRequest": {
"required": [
"interestCodeId",
"isRequired"
],
"type": "object",
"properties": {
"interestCodeId": {
"type": "integer",
"description": "Id for the Interest Code. Valid Interest Codes and their Ids can be found in the Interest Codes Datalist.",
"format": "int32"
},
"note": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "Notes about the interest code.",
"nullable": true
},
"isRequired": {
"type": "boolean",
"description": "If true, employees are required to have the same interest code on their profile to be placed on assignment for this customer."
}
},
"additionalProperties": false,
"description": "A request to update an existing Interest Code on the Customer."
},
"TwApi.Services.Customers.API.Models.UpdateCustomerInterestCodesRequest": {
"required": [
"interestCodes"
],
"type": "object",
"properties": {
"interestCodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.InterestCodes.Models.CustomerInterestCode"
},
"description": "The customer's updated interest codes"
}
},
"additionalProperties": false,
"description": "A request to update a Customer's interest codes"
},
"TwApi.Services.Customers.API.Models.UpdateCustomerOrderDefaultsRequest": {
"type": "object",
"properties": {
"purchaseOrderId": {
"type": "integer",
"description": "The specified Purchase Order must be set up on the customer. See Customers > Get Purchase Orders for a list of valid Purchase Orders.\r\nUser Defined Value which is used as the default on new orders",
"format": "int32",
"nullable": true
},
"supervisorContactId": {
"type": "integer",
"description": "Maps back to supCid in the database.",
"format": "int32",
"nullable": true
},
"burdenTypeId": {
"type": "integer",
"description": "Burden Type to define expected burden from this customer. Valid Burden Types can be found in the Burden Types Datalist.",
"format": "int32",
"nullable": true
},
"entity": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "User Defined Value which is used as the default on new orders",
"nullable": true
},
"subEntity": {
"maxLength": 25,
"minLength": 0,
"type": "string",
"description": "User Defined Value which is used as the default on new orders",
"nullable": true
},
"location": {
"maxLength": 25,
"minLength": 0,
"type": "string",
"description": "User Defined Value which is used as the default on new orders",
"nullable": true
},
"checkDelivery": {
"maxLength": 10,
"minLength": 0,
"type": "string",
"description": "User Defined Value which is used as the default on new orders",
"nullable": true
},
"customerExtra1": {
"maxLength": 10,
"minLength": 0,
"type": "string",
"description": "User Defined Value which is used as the default on new orders\r\nMaps back to custExtraOne in the database.",
"nullable": true
},
"customerExtra2": {
"maxLength": 10,
"minLength": 0,
"type": "string",
"description": "Maps back to custExtraTwo in the database.",
"nullable": true
},
"customerExtra3": {
"maxLength": 10,
"minLength": 0,
"type": "string",
"description": "Maps back to custExtraThree in the database.",
"nullable": true
},
"defaultDirectHireFeePercentage": {
"maximum": 999.99,
"minimum": -999.99,
"type": "number",
"description": "Maps back to PermPct in the database. This is \"Fee Percentage\" in the Direct Hire job orders",
"format": "double",
"nullable": true
}
},
"additionalProperties": false,
"description": "Updates default information that will be inherited by all new Job Orders created for the Customer."
},
"TwApi.Services.Customers.API.Models.UpdateCustomerSalesRequest": {
"required": [
"accountManagerServiceRepId",
"salesTeamId"
],
"type": "object",
"properties": {
"accountManagerServiceRepId": {
"type": "integer",
"description": "Service Rep Id for this customer's Account Manager. Valid Service Reps and their Ids can be found in the Service Reps Datalist. Maps back to AccountManagerSrIdent in the database.",
"format": "int32"
},
"salesTeamId": {
"type": "integer",
"description": "Id of the Sales Team responsible for this customer. Valid Sales Teams and their Ids can be found in the Sales Teams Datalist. Maps back to SalesTeamSid in the database.",
"format": "int32"
},
"howHeardOfId": {
"type": "integer",
"description": "Used for tracking how the customer heard of the staffing agency. Valid How Heard Of Ids can be found in the How Heard Of Datalist.",
"format": "int32",
"nullable": true
},
"howHeardOfDetail": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "More detailed information about how the customer heard about the staffing agency.",
"nullable": true
},
"competition": {
"maxLength": 35,
"minLength": 0,
"type": "string",
"description": "Information about competitors engagements with the customer.",
"nullable": true
},
"businessCodeId": {
"type": "string",
"description": "Business Code to categorize this customer. Valid Business Codes can be found in the Business Codes Datalist.",
"format": "uuid",
"nullable": true
},
"burdenTypeId": {
"type": "integer",
"description": "Burden Type to define expected burden from this customer. Valid Burden Types can be found in the Burden Types Datalist.",
"format": "int32",
"nullable": true
},
"salesPipelineStatusId": {
"type": "string",
"description": "Defines how far along this customer is in the sales pipeline. Valid Sales Pipeline Statuses can be found in the Sales Pipeline Statuses Datalist.",
"format": "uuid",
"nullable": true
},
"pipelineProgress": {
"type": "integer",
"description": "Numeric representation of how far along this customer is in the sales pipeline. Typically between 0 and 100.",
"format": "int32",
"nullable": true
},
"salesContactId": {
"type": "integer",
"description": "Contact Id for the Customer Contact the Sales Team is in contact with.",
"format": "int32",
"nullable": true
},
"estimatedValue": {
"type": "number",
"description": "Estimated Value of the customer.",
"format": "double",
"nullable": true
},
"estimatedValueFrequencyId": {
"type": "integer",
"description": "Frequency of the estimated value. Valid Frequencies can be found in the Frequencies Datalist. Maps back to ValueFrequencyId in the database.",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to update sales information about the customer."
},
"TwApi.Services.Customers.API.Models.UpdateCustomerWorksiteNoticeToOwnerRequest": {
"required": [
"isPrivate",
"jobAmount",
"qualified"
],
"type": "object",
"properties": {
"qualified": {
"type": "boolean",
"description": ""
},
"isPrivate": {
"type": "boolean",
"description": ""
},
"jobAmount": {
"type": "number",
"description": "",
"format": "double"
},
"reasonCodeId": {
"type": "integer",
"description": "",
"format": "int32",
"nullable": true
},
"dateFiled": {
"type": "string",
"description": "",
"format": "date-time",
"nullable": true
},
"dateReleased": {
"type": "string",
"description": "",
"format": "date-time",
"nullable": true
},
"notes": {
"type": "string",
"description": "",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to update the Notice To Owner for the customer worksite."
},
"TwApi.Services.Customers.API.Models.UpdateCustomerWorksitePayrollTaxRequest": {
"type": "object",
"properties": {
"taxMunicipalityJurisdictionId": {
"type": "integer",
"description": "Maps back to CityJurisId in the database.",
"format": "int32",
"nullable": true
},
"isExemptFromMunicipalityTax": {
"type": "boolean",
"description": "Maps back to CityTaxExempt in the database."
},
"taxCountyJurisdictionId": {
"type": "integer",
"description": "Maps back to CountyJurisId in the database.",
"format": "int32",
"nullable": true
},
"isExemptFromCountyTax": {
"type": "boolean",
"description": "Maps back to CountyTaxExempt in the database."
},
"taxSchoolDistrictJurisdictionId": {
"type": "integer",
"description": "Maps back to SchoolJurisId in the database.",
"format": "int32",
"nullable": true
},
"isExemptFromSchoolDistrictTax": {
"type": "boolean",
"description": "Maps back to SchoolTaxExempt in the database."
},
"pennsylvaniaLocalServiceTaxId": {
"type": "string",
"description": "Maps back to PrTaxPALSTGuid in the database.",
"format": "uuid",
"nullable": true
},
"psdCode": {
"type": "string",
"description": "Political Subdivision Code - Exclusive to Pennsylvania. 6 digit code that identifies municipalities in Pennsylvania and Pennsylvania alone.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to update the Payroll Tax information for the customer worksite."
},
"TwApi.Services.Customers.API.Models.UpdatePurchaseOrderRequest": {
"required": [
"appliesToChildDepartments",
"isActive",
"purchaseOrderNumber",
"purchaseOrderValue"
],
"type": "object",
"properties": {
"purchaseOrderNumber": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "The purchase order number."
},
"purchaseOrderValue": {
"minimum": 0,
"type": "number",
"description": "The amount of money available to the purchase order.",
"format": "double"
},
"endDate": {
"type": "string",
"description": "The date the purchase order ends/expires.\r\nThe date format is ISO 8601 YYYY-MM-DD.",
"format": "date-time",
"nullable": true
},
"appliesToChildDepartments": {
"type": "boolean",
"description": "Indicates whether or not child departments also have access to this purchase order."
},
"isActive": {
"type": "boolean",
"description": "Indicates whether or not the purchase order is still active for use."
}
},
"additionalProperties": false,
"description": "A request to update a Purchase Order."
},
"TwApi.Services.Customers.API.Models.UpdateWorksiteRequest": {
"required": [
"bypassAddressValidationService",
"municipality",
"postalCode",
"region",
"salesTaxJurisdictionIds",
"street1",
"taxRegion",
"worksiteName"
],
"type": "object",
"properties": {
"isActive": {
"type": "boolean",
"description": "Maps back to ActiveStatus in the database."
},
"worksiteName": {
"maxLength": 100,
"minLength": 0,
"type": "string",
"description": "Maps back to AddressDesc in the database."
},
"bypassAddressValidationService": {
"type": "boolean",
"description": "If true, address validation will be bypassed and the address will save as long as all other validation passes."
},
"attentionTo": {
"maxLength": 75,
"minLength": 0,
"type": "string",
"description": "Maps back to AddrAttnTo in the database.",
"nullable": true
},
"street1": {
"maxLength": 45,
"minLength": 0,
"type": "string",
"description": "This is the main street address. I.E. 1234 Main St."
},
"street2": {
"maxLength": 45,
"minLength": 0,
"type": "string",
"description": "This is the secondary part of the address reserved for things such as identifying suite or apartment numbers.",
"nullable": true
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "The city/municipality of the address."
},
"region": {
"maxLength": 5,
"minLength": 0,
"type": "string",
"description": "The state/region of the address."
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"type": "string",
"description": "The postal code of the address."
},
"countyId": {
"type": "integer",
"description": "Maps back to CountyCode in the database.",
"format": "int32",
"nullable": true
},
"municipalityId": {
"type": "integer",
"description": "Maps back to CityCode in the database.",
"format": "int32",
"nullable": true
},
"schoolDistrictId": {
"type": "integer",
"description": "Maps back to SchoolDistrictCode in the database.",
"format": "int32",
"nullable": true
},
"taxRegion": {
"maxLength": 5,
"minLength": 0,
"type": "string",
"description": "Worksite Tax Region. Valid Regions can be found in the Regions Datalist. Gets converted and mapped back to StateCompatibleJuris in the database."
},
"taxMunicipalityJurisdictionId": {
"type": "integer",
"description": "Maps back to CityJurisId in the database.",
"format": "int32",
"nullable": true
},
"isExemptFromMunicipalityTax": {
"type": "boolean",
"description": "Maps back to CityTaxExempt in the database."
},
"taxCountyJurisdictionId": {
"type": "integer",
"description": "Maps back to CountyJurisId in the database.",
"format": "int32",
"nullable": true
},
"isExemptFromCountyTax": {
"type": "boolean",
"description": "Maps back to CountyTaxExempt in the database."
},
"taxSchoolDistrictJurisdictionId": {
"type": "integer",
"description": "Maps back to SchoolJurisId in the database.",
"format": "int32",
"nullable": true
},
"isExemptFromSchoolDistrictTax": {
"type": "boolean",
"description": "Maps back to SchoolTaxExempt in the database."
},
"pennsylvaniaLocalServiceTaxId": {
"type": "string",
"description": "Maps back to PrTaxPALSTGuid in the database.",
"format": "uuid",
"nullable": true
},
"directions": {
"maxLength": 1000,
"minLength": 0,
"type": "string",
"description": "Maps back to Directions1 in the database.",
"nullable": true
},
"dressCode": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "Maps back to Dress in the database.",
"nullable": true
},
"isPublicTransportationAccessible": {
"type": "boolean",
"description": "Maps back to AccessiblePublicTransportation in the database.",
"nullable": true
},
"timeClockTimeZoneId": {
"type": "string",
"description": "Defines the Time Zone that timeclocks at this worksite are in. Valid Time Zones can be found in the Time Clock Time Zones Datalist. Maps back to TimeZoneId in the database.",
"format": "uuid",
"nullable": true
},
"isDaylightSavingsTimeObserved": {
"type": "boolean",
"description": "Maps back to DSTObserved in the database."
},
"salesTaxJurisdictionIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "A list of Sales Taxes applicable to this worksite. Sales Taxes need to be set up on the customer as well. See Customer > Get Sales Taxes for a list of available Sales Taxes. Maps back to the SalesTaxJurisdictionGUID column in dbo.CustomerSalesTaxJurisdiction.\r\nAn empty list will delete all sales taxes on the client."
},
"accrualId": {
"type": "string",
"description": "Accrual override for the worksite",
"format": "uuid",
"nullable": true
},
"psdCode": {
"type": "string",
"description": "Political Subdivision Code - Exclusive to Pennsylvania. 6 digit code that identifies municipalities in Pennsylvania and Pennsylvania alone.",
"nullable": true
},
"isTimeClockEnabled": {
"type": "boolean",
"description": "Indicates if the Time Clock should be enabled."
},
"applyTimeClockToExistingJobOrders": {
"type": "boolean",
"description": "Indicates if the IsTimeClockEnabled property should also be set on all related Job Orders."
},
"localizedWorksiteDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TempWorks.TwApi.Common.Models.LocalizedWorksiteDetails"
},
"description": "The localized worksite directions and dress code.",
"nullable": true
},
"remoteWorkStatusId": {
"type": "integer",
"description": "The status of the work location.",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to update a Worksite."
},
"TwApi.Services.Customers.Service.Commands.AbsenceReasons.CreateCustomerAbsenceReasonCommand.Result": {
"type": "object",
"properties": {
"reasonId": {
"type": "string",
"format": "uuid"
},
"customerId": {
"type": "integer",
"format": "int64"
},
"absenceReason": {
"type": "string",
"nullable": true
},
"active": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.AbsenceReasons.CustomerAbsenceReasonsQuery.Result": {
"type": "object",
"properties": {
"reasonId": {
"type": "string",
"format": "uuid"
},
"customerId": {
"type": "integer",
"format": "int64"
},
"absenceReason": {
"type": "string",
"nullable": true
},
"active": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.Accruals.CustomerAccrualsList.Result": {
"type": "object",
"properties": {
"customerId": {
"type": "integer",
"format": "int64"
},
"customerAccrualId": {
"type": "string",
"format": "uuid"
},
"accrualId": {
"type": "string",
"format": "uuid"
},
"isActive": {
"type": "boolean"
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"accrualTypeId": {
"type": "string",
"format": "uuid"
},
"accrualType": {
"type": "string",
"nullable": true
},
"createdByServiceRepId": {
"type": "integer",
"format": "int32"
},
"createdByServiceRepName": {
"type": "string",
"nullable": true
},
"accrueOnDT": {
"type": "boolean"
},
"accrueOnOT": {
"type": "boolean"
},
"allowNegativeBalance": {
"type": "boolean"
},
"applyToDepartments": {
"type": "boolean"
},
"defaultSetByCustomerId": {
"type": "integer",
"format": "int64",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.BillingSetup.CreateCustomerInvoiceLineItemDetailCommand.Result": {
"type": "object",
"properties": {
"lineItemDetailId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.BillingSetup.CustomerBillingSetupQuery.Result": {
"type": "object",
"properties": {
"consolidateInvoicingWithParent": {
"type": "boolean"
},
"billingCustomerId": {
"type": "integer",
"format": "int64"
},
"billingCustomerName": {
"type": "string",
"nullable": true
},
"billingDepartmentName": {
"type": "string",
"nullable": true
},
"billingFrequencyId": {
"type": "string",
"format": "uuid"
},
"billingFrequency": {
"type": "string",
"nullable": true
},
"monthlyBillingCycleId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"monthlyBillingCycle": {
"type": "string",
"nullable": true
},
"invoiceNotes": {
"type": "string",
"nullable": true
},
"invoiceReportId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"invoiceReport": {
"type": "string",
"nullable": true
},
"invoiceReportPath": {
"type": "string",
"nullable": true
},
"invoiceEmailTemplateId": {
"type": "string",
"format": "uuid"
},
"invoiceEmailTemplate": {
"type": "string",
"nullable": true
},
"currencyId": {
"type": "integer",
"format": "int32"
},
"currencyName": {
"type": "string",
"nullable": true
},
"invoiceHandlingCode": {
"type": "integer",
"format": "int32",
"nullable": true
},
"invoiceHandlingDescription": {
"type": "string",
"nullable": true
},
"invoiceCCEmailAddress": {
"type": "string",
"nullable": true
},
"consolidateInvoiceWithParent": {
"type": "boolean"
},
"invoicingMethodId": {
"type": "integer",
"format": "int32"
},
"invoicingMethod": {
"type": "string",
"nullable": true
},
"splitInvoicesByAssignment": {
"type": "boolean"
},
"splitInvoicesByBranch": {
"type": "boolean"
},
"splitInvoicesByCostCenter": {
"type": "boolean"
},
"splitInvoicesByDepartment": {
"type": "boolean"
},
"splitInvoicesByDivision": {
"type": "boolean"
},
"splitInvoicesByEmployee": {
"type": "boolean"
},
"splitInvoicesByJobOrder": {
"type": "boolean"
},
"splitInvoicesByJobTitle": {
"type": "boolean"
},
"splitInvoicesByPayCode": {
"type": "boolean"
},
"splitInvoicesByPurchaseOrder": {
"type": "boolean"
},
"splitInvoicesByShift": {
"type": "boolean"
},
"splitInvoicesBySubEntity": {
"type": "boolean"
},
"splitInvoicesBySupervisor": {
"type": "boolean"
},
"splitInvoicesByWeekEndDate": {
"type": "boolean"
},
"splitInvoicesByWorksite": {
"type": "boolean"
},
"splitInvoicesByDepartmentAddress": {
"type": "boolean"
},
"canPreviewInvoiceStyle": {
"type": "boolean"
},
"invoiceRecipients": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.InvoiceRecipient"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.BillingSetup.CustomerInvoiceLineItemDetailsQuery.Result": {
"type": "object",
"properties": {
"customerLineItemDetailId": {
"type": "integer",
"format": "int32"
},
"invoiceLineItemDetailId": {
"type": "string",
"nullable": true
},
"invoiceLineItemDetail": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.Candidate.CreateCustomerCandidateCommand.CreateCustomerCandidateResponse": {
"type": "object",
"properties": {
"candidateId": {
"type": "string",
"format": "uuid"
},
"customerId": {
"type": "integer",
"format": "int64"
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"employeeFirstName": {
"type": "string",
"nullable": true
},
"employeeLastName": {
"type": "string",
"nullable": true
},
"employeeMiddleName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.Candidate.CustomerCandidatesQuery.Result": {
"type": "object",
"properties": {
"candidateId": {
"type": "string",
"format": "uuid"
},
"customerId": {
"type": "integer",
"format": "int64"
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"employeeFirstName": {
"type": "string",
"nullable": true
},
"employeeLastName": {
"type": "string",
"nullable": true
},
"employeeMiddleName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.CreateCustomerAccrual.Result": {
"type": "object",
"properties": {
"customerAccrualId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.CreateCustomerContactRoleCommand.Result": {
"type": "object",
"properties": {
"affectedJobOrderIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"nullable": true
},
"affectedCustomerIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.CreateCustomerDefaultJobDescription.Result": {
"type": "object",
"properties": {
"jobDescriptionId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.CreateCustomerDefaultMultiplierCodeCommand.Result": {
"type": "object",
"properties": {
"defaultMultiplierCodeId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.CreateCustomerDefaultRequiredDocumentType.Result": {
"type": "object",
"properties": {
"customerRequiredDocumentTypeId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.CreateCustomerDefaultShiftCommand.Result": {
"type": "object",
"properties": {
"shiftId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.CreateCustomerDefaultWorkerCompCodeCommand.Result": {
"type": "object",
"properties": {
"defaultWorkerCompCodeId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.CreateCustomerDepartmentCommand.Result": {
"type": "object",
"properties": {
"customerId": {
"type": "integer",
"format": "int64"
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.CreditAndPayRoll.CreditAndPayRollSetupQuery.Result": {
"type": "object",
"properties": {
"creditLimit": {
"type": "number",
"format": "double",
"nullable": true
},
"paymentTermsCodeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"paymentTerms": {
"type": "string",
"nullable": true
},
"payPeriods": {
"type": "integer",
"format": "int32",
"nullable": true
},
"payPeriodName": {
"type": "string",
"nullable": true
},
"weekEndDay": {
"type": "string",
"nullable": true
},
"creditAnalystServiceRepId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"creditAnalyst": {
"type": "string",
"nullable": true
},
"payrollNote": {
"type": "string",
"nullable": true
},
"customerTypeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"customerType": {
"type": "string",
"nullable": true
},
"creditCheckDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"creditComment": {
"type": "string",
"nullable": true
},
"holdCode": {
"type": "string",
"nullable": true
},
"holdDescription": {
"type": "string",
"nullable": true
},
"overTimePlanId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"overTimePlan": {
"type": "string",
"nullable": true
},
"workerCompCodeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"workerCompCode": {
"type": "string",
"nullable": true
},
"monthlyPayCycleId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"monthlyPayCycle": {
"type": "string",
"nullable": true
},
"checkDelivery": {
"type": "string",
"nullable": true
},
"mileageRate": {
"type": "number",
"format": "double",
"nullable": true
},
"arBalance": {
"type": "number",
"format": "double"
},
"arCurrent": {
"type": "number",
"format": "double"
},
"aR1To30": {
"type": "number",
"format": "double"
},
"arOver30": {
"type": "number",
"format": "double"
},
"arOver60": {
"type": "number",
"format": "double"
},
"arOver90": {
"type": "number",
"format": "double"
},
"daySalesOutstanding": {
"type": "integer",
"format": "int32",
"nullable": true
},
"volumeDiscount": {
"type": "number",
"format": "double",
"nullable": true
},
"lifetimeSales": {
"type": "number",
"format": "double"
},
"salesYTD": {
"type": "number",
"format": "double"
},
"salesTrailing": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.CustomerContactMessageDetails.CustomerMessageSummary": {
"type": "object",
"properties": {
"isDepartmentMessage": {
"type": "boolean"
},
"attachedDocuments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.Documents.DocumentDetails"
},
"nullable": true
},
"id": {
"type": "integer",
"format": "int64"
},
"contactMessageRootGuid": {
"type": "string",
"format": "uuid"
},
"message": {
"type": "string",
"nullable": true
},
"date": {
"type": "string",
"format": "date-time"
},
"actionId": {
"type": "integer",
"format": "int32"
},
"action": {
"type": "string",
"nullable": true
},
"actionDescription": {
"type": "string",
"nullable": true
},
"taskId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"authorSrIdent": {
"type": "integer",
"format": "int32"
},
"author": {
"type": "string",
"nullable": true
},
"linkedDocumentsCount": {
"type": "integer",
"format": "int32"
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageLink"
},
"nullable": true
},
"primaryOriginTypeId": {
"$ref": "#/components/schemas/TwApi.Common.Enums.OriginType"
},
"primaryOriginId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"messageLinkedDocuments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageLinkedDocument"
},
"nullable": true
},
"viaIntegrationName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.CustomerContactMessagesQuery.CustomerMessageSummary": {
"type": "object",
"properties": {
"isDepartmentMessage": {
"type": "boolean"
},
"id": {
"type": "integer",
"format": "int64"
},
"contactMessageRootGuid": {
"type": "string",
"format": "uuid"
},
"message": {
"type": "string",
"nullable": true
},
"date": {
"type": "string",
"format": "date-time"
},
"actionId": {
"type": "integer",
"format": "int32"
},
"action": {
"type": "string",
"nullable": true
},
"actionDescription": {
"type": "string",
"nullable": true
},
"taskId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"authorSrIdent": {
"type": "integer",
"format": "int32"
},
"author": {
"type": "string",
"nullable": true
},
"linkedDocumentsCount": {
"type": "integer",
"format": "int32"
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageLink"
},
"nullable": true
},
"primaryOriginTypeId": {
"$ref": "#/components/schemas/TwApi.Common.Enums.OriginType"
},
"primaryOriginId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"messageLinkedDocuments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageLinkedDocument"
},
"nullable": true
},
"viaIntegrationName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.CustomerContactsInRolesQuery.Result": {
"type": "object",
"properties": {
"customerContactRoleId": {
"type": "integer",
"format": "int64"
},
"contactId": {
"type": "integer",
"format": "int32"
},
"lastName": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"contactRoleId": {
"type": "integer",
"format": "int32"
},
"contactRole": {
"type": "string",
"nullable": true
},
"customerContactRoleGUID": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.CustomerContactsQuery.Result": {
"type": "object",
"properties": {
"contactId": {
"type": "integer",
"format": "int32"
},
"lastName": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"customerId": {
"type": "integer",
"format": "int64"
},
"customerName": {
"type": "string",
"nullable": true
},
"departmentName": {
"type": "string",
"nullable": true
},
"officePhoneCountryCallingCode": {
"type": "integer",
"format": "int32",
"nullable": true
},
"officePhone": {
"type": "string",
"nullable": true
},
"emailAddress": {
"type": "string",
"nullable": true
},
"cellPhoneCountryCallingCode": {
"type": "integer",
"format": "int32",
"nullable": true
},
"cellPhone": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.CustomerDefaultJobDescription.Result": {
"type": "object",
"properties": {
"jobDescriptionId": {
"type": "string",
"format": "uuid"
},
"jobTitleId": {
"type": "integer",
"format": "int32"
},
"jobDescription": {
"type": "string",
"nullable": true
},
"publicJobTitle": {
"type": "string",
"nullable": true
},
"publicJobDescription": {
"type": "string",
"nullable": true
},
"educationSummary": {
"type": "string",
"nullable": true
},
"experienceSummary": {
"type": "string",
"nullable": true
},
"localizedPublicJobDescriptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.LocalizedPublicJobDescription"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.CustomerDefaultJobDescriptions.Result": {
"type": "object",
"properties": {
"jobDescriptionId": {
"type": "string",
"format": "uuid"
},
"jobTitle": {
"type": "string",
"nullable": true
},
"jobDescription": {
"type": "string",
"nullable": true
},
"publicJobTitle": {
"type": "string",
"nullable": true
},
"publicJobDescription": {
"type": "string",
"nullable": true
},
"educationSummary": {
"type": "string",
"nullable": true
},
"experienceSummary": {
"type": "string",
"nullable": true
},
"jobTitleId": {
"type": "integer",
"format": "int32"
},
"customerOwner": {
"type": "integer",
"format": "int64"
},
"localizedPublicJobDescriptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.LocalizedPublicJobDescription"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.CustomerDefaultMultiplierCodesQuery.Result": {
"type": "object",
"properties": {
"defaultMultiplierCodeId": {
"type": "string",
"format": "uuid"
},
"multiplierCodeId": {
"type": "integer",
"format": "int32"
},
"multiplierCode": {
"type": "string",
"nullable": true
},
"priority": {
"type": "integer",
"format": "int32"
},
"isInherited": {
"type": "boolean"
},
"levelDescription": {
"type": "string",
"nullable": true
},
"originId": {
"type": "integer",
"format": "int64"
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.CustomerDefaultRequiredDocumentTypes.Result": {
"type": "object",
"properties": {
"customerRequiredDocumentTypeId": {
"type": "string",
"format": "uuid"
},
"notes": {
"type": "string",
"nullable": true
},
"isRequired": {
"type": "boolean"
},
"isActive": {
"type": "boolean"
},
"requiredDocumentTypeId": {
"type": "integer",
"format": "int32"
},
"requiredDocumentType": {
"type": "string",
"nullable": true
},
"requiredDocumentAuthorityId": {
"type": "integer",
"format": "int32"
},
"requiredDocumentAuthority": {
"type": "string",
"nullable": true
},
"requiredDocumentCategoryId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"requiredDocumentCategory": {
"type": "string",
"nullable": true
},
"isInherited": {
"type": "boolean"
},
"customerId": {
"type": "integer",
"format": "int64"
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.CustomerDefaultShiftsQuery.Result": {
"type": "object",
"properties": {
"shiftId": {
"type": "string",
"format": "uuid"
},
"shift": {
"type": "string",
"nullable": true
},
"startTime": {
"type": "string",
"format": "date-time"
},
"endTime": {
"type": "string",
"format": "date-time"
},
"shiftNotes": {
"type": "string",
"nullable": true
},
"isScheduledForSunday": {
"type": "boolean"
},
"isScheduledForMonday": {
"type": "boolean"
},
"isScheduledForTuesday": {
"type": "boolean"
},
"isScheduledForWednesday": {
"type": "boolean"
},
"isScheduledForThursday": {
"type": "boolean"
},
"isScheduledForFriday": {
"type": "boolean"
},
"isScheduledForSaturday": {
"type": "boolean"
},
"minutesOfBreakPerDay": {
"type": "number",
"format": "double"
},
"isInherited": {
"type": "boolean"
},
"levelDescription": {
"type": "string",
"nullable": true
},
"originId": {
"type": "integer",
"format": "int64"
},
"localizedShiftValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TempWorks.TwApi.Common.Models.LocalizedShiftValues"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.CustomerDefaultWorkerCompCodesQuery.Result": {
"type": "object",
"properties": {
"defaultWorkerCompCodeId": {
"type": "string",
"format": "uuid"
},
"workerCompCodeId": {
"type": "integer",
"format": "int32"
},
"workerCompCode": {
"type": "string",
"nullable": true
},
"workerCompCodeDescription": {
"type": "string",
"nullable": true
},
"priority": {
"type": "integer",
"format": "int32"
},
"isInherited": {
"type": "boolean"
},
"levelDescription": {
"type": "string",
"nullable": true
},
"originId": {
"type": "integer",
"format": "int64"
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.CustomerDefaultsSettingsQuery.Result": {
"type": "object",
"properties": {
"applyMultiplierCodesToDepartments": {
"type": "boolean"
},
"applyShiftsToDepartments": {
"type": "boolean"
},
"applyWorkerCompCodesToDepartments": {
"type": "boolean"
},
"applyRequiredDocumentsToDepartments": {
"type": "boolean"
},
"applyDefaultJobDescriptionToDepartments": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.CustomerDepartmentsQuery.Result": {
"type": "object",
"properties": {
"customerId": {
"type": "integer",
"format": "int64"
},
"parentCustomerId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"customerName": {
"type": "string",
"nullable": true
},
"departmentName": {
"type": "string",
"nullable": true
},
"supervisorContactId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"supervisorFirstName": {
"type": "string",
"nullable": true
},
"supervisorLastName": {
"type": "string",
"nullable": true
},
"customerStatus": {
"type": "string",
"nullable": true
},
"customerStatusId": {
"type": "string",
"nullable": true
},
"branchId": {
"type": "integer",
"format": "int32"
},
"branch": {
"type": "string",
"nullable": true
},
"hasDepartments": {
"type": "boolean"
},
"departments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerDepartmentsQuery.Result"
},
"nullable": true
},
"address": {
"$ref": "#/components/schemas/TempWorks.TwApi.Common.Models.Address"
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.CustomerDetailsMetadataQuery.Result": {
"type": "object",
"properties": {
"canChangeCustomerStatus": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.CustomerDetailsQuery.Result": {
"type": "object",
"properties": {
"customerId": {
"type": "integer",
"format": "int64"
},
"customerRootGuid": {
"type": "string",
"format": "uuid"
},
"customerName": {
"type": "string",
"nullable": true
},
"departmentName": {
"type": "string",
"nullable": true
},
"parentCustomerId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"parentCustomerName": {
"type": "string",
"nullable": true
},
"parentDepartmentName": {
"type": "string",
"nullable": true
},
"rootCustomerId": {
"type": "integer",
"format": "int64"
},
"branchId": {
"type": "integer",
"format": "int32"
},
"branchName": {
"type": "string",
"nullable": true
},
"customerStatusId": {
"type": "string",
"nullable": true
},
"customerStatus": {
"type": "string",
"nullable": true
},
"website": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"dateActivated": {
"type": "string",
"format": "date-time"
},
"address": {
"$ref": "#/components/schemas/TempWorks.TwApi.Common.Models.Address"
},
"billingAddress": {
"$ref": "#/components/schemas/TempWorks.TwApi.Common.Models.Address"
},
"worksiteId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"worksiteName": {
"type": "string",
"nullable": true
},
"worksiteAddress": {
"$ref": "#/components/schemas/TempWorks.TwApi.Common.Models.Address"
},
"note": {
"type": "string",
"nullable": true
},
"nationalIndustryClassificationSystemCode": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.CustomerFetchSalesPipeline.Result": {
"type": "object",
"properties": {
"customerId": {
"type": "integer",
"format": "int64"
},
"customerName": {
"type": "string",
"nullable": true
},
"departmentName": {
"type": "string",
"nullable": true
},
"accountManagerServiceRepId": {
"type": "integer",
"format": "int32"
},
"accountManager": {
"type": "string",
"nullable": true
},
"customerStatus": {
"type": "string",
"nullable": true
},
"daysInProspectStatus": {
"type": "integer",
"format": "int32",
"nullable": true
},
"salesPipelineStatus": {
"type": "string",
"nullable": true
},
"salesPipelineStatusId": {
"type": "string",
"format": "uuid"
},
"daysInSalesPipelineStatus": {
"type": "integer",
"format": "int32",
"nullable": true
},
"pipelineProgress": {
"type": "integer",
"format": "int32",
"nullable": true
},
"estimatedValue": {
"type": "number",
"format": "double",
"nullable": true
},
"estimatedValueFrequencyId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"estimatedValueFrequency": {
"type": "string",
"nullable": true
},
"howHeardOfId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"howHeardOf": {
"type": "string",
"nullable": true
},
"howHeardOfDetail": {
"type": "string",
"nullable": true
},
"salesTeam": {
"type": "string",
"nullable": true
},
"salesTeamId": {
"type": "integer",
"format": "int32"
},
"salesContactId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"salesContactFirstName": {
"type": "string",
"nullable": true
},
"salesContactLastName": {
"type": "string",
"nullable": true
},
"lastMessage": {
"type": "string",
"nullable": true
},
"lastMessageDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"lastMessageAction": {
"type": "string",
"nullable": true
},
"lastMessageAuthorServiceRepId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"lastMessageAuthorServiceRep": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.CustomerFinancialsQuery.Result": {
"type": "object",
"properties": {
"customerId": {
"type": "integer",
"format": "int64"
},
"balanceDue": {
"type": "number",
"format": "double"
},
"arBalance": {
"type": "number",
"format": "double"
},
"lastPaymentDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"salesYtd": {
"type": "number",
"format": "double"
},
"lifetimeSales": {
"type": "number",
"format": "double"
},
"salesTrailing": {
"type": "number",
"format": "double"
},
"creditLimit": {
"type": "number",
"format": "double"
},
"sutaJurisId": {
"type": "integer",
"format": "int32"
},
"sutaJuris": {
"type": "string",
"nullable": true
},
"workerCompCodeId": {
"type": "integer",
"format": "int32"
},
"workerCompCode": {
"type": "string",
"nullable": true
},
"burdenRate": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.CustomerInvoiceHistoryQuery.Result": {
"type": "object",
"properties": {
"invoiceId": {
"type": "integer",
"format": "int32"
},
"invoiceNumber": {
"type": "string",
"nullable": true
},
"invoiceDate": {
"type": "string",
"format": "date-time"
},
"dueDate": {
"type": "string",
"format": "date-time"
},
"invoiceAmount": {
"type": "number",
"format": "double"
},
"amountPaid": {
"type": "number",
"format": "double"
},
"invoiceBalance": {
"type": "number",
"format": "double"
},
"dateOfMostRecentPayment": {
"type": "string",
"format": "date-time",
"nullable": true
},
"branchId": {
"type": "integer",
"format": "int32"
},
"branch": {
"type": "string",
"nullable": true
},
"costCenter": {
"type": "string",
"nullable": true
},
"isPosted": {
"type": "boolean"
},
"masterInvoiceNumber": {
"type": "string",
"nullable": true
},
"masterInvoiceId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.CustomerMultiplierCodesQuery.Result": {
"type": "object",
"properties": {
"multiplierCodeId": {
"type": "integer",
"format": "int32"
},
"multiplierCode": {
"type": "string",
"nullable": true
},
"priority": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.CustomerOrderDefaultsQuery.Result": {
"type": "object",
"properties": {
"customerId": {
"type": "integer",
"format": "int64"
},
"purchaseOrderId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"poNumber": {
"type": "string",
"nullable": true
},
"supervisorContactId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"supervisorFirstName": {
"type": "string",
"nullable": true
},
"supervisorLastName": {
"type": "string",
"nullable": true
},
"burdenTypeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"burdenTypeName": {
"type": "string",
"nullable": true
},
"entity": {
"type": "string",
"nullable": true
},
"subEntity": {
"type": "string",
"nullable": true
},
"location": {
"type": "string",
"nullable": true
},
"checkDelivery": {
"type": "string",
"nullable": true
},
"customerExtra1": {
"type": "string",
"nullable": true
},
"customerExtra2": {
"type": "string",
"nullable": true
},
"customerExtra3": {
"type": "string",
"nullable": true
},
"defaultPermanentOrder": {
"type": "number",
"format": "double",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.CustomerOrdersQuery.Result": {
"type": "object",
"properties": {
"orderId": {
"type": "integer",
"format": "int64"
},
"jobTitleId": {
"type": "integer",
"format": "int32"
},
"jobTitle": {
"type": "string",
"nullable": true
},
"orderStatusId": {
"type": "integer",
"format": "int32"
},
"orderStatus": {
"type": "string",
"nullable": true
},
"payRate": {
"type": "number",
"format": "double"
},
"billRate": {
"type": "number",
"format": "double"
},
"positionsRequired": {
"type": "integer",
"format": "int32"
},
"positionsFilled": {
"type": "integer",
"format": "int32"
},
"orderTypeId": {
"type": "integer",
"format": "int32"
},
"orderType": {
"type": "string",
"nullable": true
},
"startDate": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.CustomerParentCustomerMetadata.Result": {
"type": "object",
"properties": {
"canChangeParentCustomer": {
"type": "boolean",
"readOnly": true
},
"canChangeParentCustomerValidationErrors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Customers.Service.Commands.CustomerParentCustomerMetadata.ValidationError"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.CustomerParentCustomerMetadata.ValidationError": {
"type": "object",
"properties": {
"message": {
"type": "string",
"nullable": true
},
"errorCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.CustomerRoleCheckActiveAssignments.Result": {
"type": "object",
"properties": {
"numberOfInactiveJobOrdersWithActiveAssignments": {
"type": "integer",
"format": "int32"
},
"numberOfInactiveDepartmentsWithActiveAssignments": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.CustomerSalesInformationQuery.Result": {
"type": "object",
"properties": {
"customerId": {
"type": "integer",
"format": "int64"
},
"accountManagerServiceRepId": {
"type": "integer",
"format": "int32"
},
"accountManager": {
"type": "string",
"nullable": true
},
"salesTeamId": {
"type": "integer",
"format": "int32"
},
"salesTeam": {
"type": "string",
"nullable": true
},
"howHeardOfId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"howHeardOf": {
"type": "string",
"nullable": true
},
"howHeardOfDetail": {
"type": "string",
"nullable": true
},
"competition": {
"type": "string",
"nullable": true
},
"businessCodeId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"businessCode": {
"type": "string",
"nullable": true
},
"salesPipelineStatusId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"salesPipelineStatus": {
"type": "string",
"nullable": true
},
"pipelineProgress": {
"type": "integer",
"format": "int32",
"nullable": true
},
"salesContactId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"salesContactFirstName": {
"type": "string",
"nullable": true
},
"salesContactLastName": {
"type": "string",
"nullable": true
},
"estimatedValue": {
"type": "number",
"format": "double",
"nullable": true
},
"estimatedValueFrequencyId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"estimatedValueFrequency": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.CustomerStatusUpdateCommand.Result": {
"type": "object",
"properties": {
"statusChanged": {
"type": "boolean"
},
"additionalActionMessages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.StatusChange.AdditionalActionMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.CustomerWorkerCompCodesQuery.Result": {
"type": "object",
"properties": {
"priority": {
"type": "integer",
"format": "int32"
},
"workerCompCodeId": {
"type": "integer",
"format": "int32"
},
"workerCompCode": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"percentage": {
"type": "number",
"format": "double"
},
"region": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.DeleteCustomerContactRoleCommand.Result": {
"type": "object",
"properties": {
"affectedJobOrderIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"nullable": true
},
"affectedCustomerIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.InterestCodes.CreateCustomerInterestCodeCommand.Result": {
"type": "object",
"properties": {
"customerInterestCodeId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.InterestCodes.CustomerInterestCodesQuery.Result": {
"type": "object",
"properties": {
"customerInterestCodeGuid": {
"type": "string",
"format": "uuid"
},
"customerInterestCodeId": {
"type": "integer",
"format": "int32"
},
"interestCodeId": {
"type": "integer",
"format": "int32"
},
"interestCode": {
"type": "string",
"nullable": true
},
"note": {
"type": "string",
"nullable": true
},
"isRequired": {
"type": "boolean"
},
"subCategoryId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"subCategory": {
"type": "string",
"nullable": true
},
"dateCreated": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.InterestCodes.Models.CustomerInterestCode": {
"type": "object",
"properties": {
"interestCodeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"note": {
"type": "string",
"nullable": true
},
"isRequired": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.PurchaseOrders.AssignPurchaseOrderToRelatedEntitiesCommand.Result": {
"type": "object",
"properties": {
"affectedJobOrderIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"nullable": true
},
"affectedAssignmentIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"nullable": true
},
"affectedTimecardIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.PurchaseOrders.CreateCustomerPurchaseOrderCommand.Result": {
"type": "object",
"properties": {
"purchaseOrderId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.PurchaseOrders.CustomerPurchaseOrderQuery.Result": {
"type": "object",
"properties": {
"purchaseOrderId": {
"type": "integer",
"format": "int32"
},
"purchaseOrderNumber": {
"type": "string",
"nullable": true
},
"purchaseOrderValue": {
"type": "number",
"format": "double",
"nullable": true
},
"endDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"warningAmount": {
"type": "number",
"format": "double",
"nullable": true
},
"warningDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"dateCreated": {
"type": "string",
"format": "date-time"
},
"createdByServiceRepId": {
"type": "integer",
"format": "int32"
},
"createdByServiceRep": {
"type": "string",
"nullable": true
},
"amountUsed": {
"type": "number",
"format": "double",
"nullable": true
},
"appliesToChildDepartments": {
"type": "boolean"
},
"customerId": {
"type": "integer",
"format": "int64"
},
"customerName": {
"type": "string",
"nullable": true
},
"departmentName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.PurchaseOrders.CustomerPurchaseOrdersQuery.Result": {
"type": "object",
"properties": {
"purchaseOrderId": {
"type": "integer",
"format": "int32"
},
"purchaseOrderNumber": {
"type": "string",
"nullable": true
},
"purchaseOrderValue": {
"type": "number",
"format": "double",
"nullable": true
},
"purchaseOrderEndDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"warningAmount": {
"type": "number",
"format": "double",
"nullable": true
},
"warningDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"dateCreated": {
"type": "string",
"format": "date-time"
},
"createdByServiceRepId": {
"type": "integer",
"format": "int32"
},
"createdByServiceRep": {
"type": "string",
"nullable": true
},
"amountUsed": {
"type": "number",
"format": "double",
"nullable": true
},
"appliesToChildDepartments": {
"type": "boolean"
},
"isInheritedFromParent": {
"type": "boolean"
},
"customerId": {
"type": "integer",
"format": "int64"
},
"customerName": {
"type": "string",
"nullable": true
},
"departmentName": {
"type": "string",
"nullable": true
},
"balance": {
"type": "number",
"format": "double",
"nullable": true
},
"status": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.Vendors.CreateCustomerCompany.Result": {
"type": "object",
"properties": {
"customerVendorCompanyId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.Vendors.CustomerVendorDetails.Result": {
"type": "object",
"properties": {
"customerVendorCompanyId": {
"type": "integer",
"format": "int32"
},
"customerId": {
"type": "integer",
"format": "int64"
},
"vendorCompanyId": {
"type": "integer",
"format": "int32"
},
"jobTitleId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"orderDelayInHours": {
"type": "number",
"format": "double",
"nullable": true
},
"maxCandidatesPerReq": {
"type": "integer",
"format": "int32",
"nullable": true
},
"jobOrderTypeIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.Vendors.CustomerVendorsList.Result": {
"type": "object",
"properties": {
"customerVendorCompanyId": {
"type": "integer",
"format": "int64"
},
"customerId": {
"type": "integer",
"format": "int64"
},
"vendorCompanyId": {
"type": "integer",
"format": "int64"
},
"vendorCompanyName": {
"type": "string",
"nullable": true
},
"companyIsVendor": {
"type": "boolean"
},
"jobTitleId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"jobTitle": {
"type": "string",
"nullable": true
},
"orderDelayInHours": {
"type": "number",
"format": "double"
},
"maxCandidatesPerReq": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.Worksite.CreateCustomerWorksiteNoticeToOwnerCommand.Result": {
"type": "object",
"properties": {
"noticeToOwnerId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.Worksite.CreateWorksiteCommand.Result": {
"type": "object",
"properties": {
"worksiteId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.Worksite.CustomerWorksiteDetailsQuery.Result": {
"type": "object",
"properties": {
"worksiteId": {
"type": "integer",
"format": "int32"
},
"worksiteName": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"customerId": {
"type": "integer",
"format": "int64"
},
"customerName": {
"type": "string",
"nullable": true
},
"departmentName": {
"type": "string",
"nullable": true
},
"address": {
"$ref": "#/components/schemas/TempWorks.TwApi.Common.Models.ExtendedAddress"
},
"directions": {
"type": "string",
"nullable": true
},
"dressCode": {
"type": "string",
"nullable": true
},
"timeClockTimeZoneId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"timeClockTimeZone": {
"type": "string",
"nullable": true
},
"isDaylightSavingsTimeObserved": {
"type": "boolean"
},
"isPublicTransportationAccessible": {
"type": "boolean",
"nullable": true
},
"taxRegion": {
"type": "string",
"nullable": true
},
"taxCountyJurisdiction": {
"type": "string",
"nullable": true
},
"taxCountyJurisdictionId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"isExemptFromCountyTax": {
"type": "boolean"
},
"taxMunicipalityJurisdiction": {
"type": "string",
"nullable": true
},
"taxMunicipalityJurisdictionId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"isExemptFromMunicipalityTax": {
"type": "boolean"
},
"taxSchoolDistrictJurisdiction": {
"type": "string",
"nullable": true
},
"taxSchoolDistrictJurisdictionId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"isExemptFromSchoolDistrictTax": {
"type": "boolean"
},
"pennsylvaniaLocalServiceTaxId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"pennsylvaniaLocalServiceTax": {
"type": "string",
"nullable": true
},
"salesTaxes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TempWorks.TwApi.Common.Models.SalesTax"
},
"nullable": true
},
"accrualId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"accrual": {
"type": "string",
"nullable": true
},
"psdCode": {
"type": "string",
"nullable": true
},
"isTimeClockEnabled": {
"type": "boolean"
},
"localizedWorksiteDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TempWorks.TwApi.Common.Models.LocalizedWorksiteDetails"
},
"nullable": true
},
"remoteWorkStatusId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"remoteWorkStatus": {
"type": "string",
"nullable": true
},
"customerAddressRootGuid": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.Worksite.CustomerWorksiteNoticeToOwnerQuery.Result": {
"type": "object",
"properties": {
"noticeToOwnerId": {
"type": "integer",
"format": "int32"
},
"qualified": {
"type": "boolean"
},
"isPrivate": {
"type": "boolean"
},
"reasonCodeId": {
"type": "integer",
"format": "int32"
},
"reasonCode": {
"type": "string",
"nullable": true
},
"jobAmount": {
"type": "number",
"format": "double"
},
"dateFiled": {
"type": "string",
"format": "date-time",
"nullable": true
},
"dateReleased": {
"type": "string",
"format": "date-time",
"nullable": true
},
"notes": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Customers.Service.Commands.Worksite.CustomerWorksitesQuery.Result": {
"type": "object",
"properties": {
"worksiteId": {
"type": "integer",
"format": "int32"
},
"customerId": {
"type": "integer",
"format": "int64"
},
"worksiteName": {
"type": "string",
"nullable": true
},
"address": {
"$ref": "#/components/schemas/TempWorks.TwApi.Common.Models.Address"
},
"isActive": {
"type": "boolean"
},
"accrualId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"accrual": {
"type": "string",
"nullable": true
},
"isTimeClockEnabled": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.AcaEmployeeAdjustmentTypeListQuery.Result": {
"type": "object",
"properties": {
"acaEmployeeAdjustmentTypeId": {
"type": "integer",
"format": "int32"
},
"acaEmployeeAdjustmentType": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.AcaEmploymentStatusListQuery.Result": {
"type": "object",
"properties": {
"acaEmploymentStatusId": {
"type": "string",
"format": "uuid"
},
"acaEmploymentStatus": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.AccrualList.Result": {
"type": "object",
"properties": {
"accrualId": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"accrualType": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.AccrualTierDataListQuery.Result": {
"type": "object",
"properties": {
"accrualTierId": {
"type": "string",
"format": "uuid"
},
"accrualTier": {
"type": "string",
"nullable": true
},
"defaultAccrualRate": {
"type": "number",
"format": "double"
},
"defaultDepletionRate": {
"type": "number",
"format": "double"
},
"defaultAnniversaryMaxBalance": {
"type": "number",
"format": "double",
"nullable": true
},
"defaultCalendarYearMaxAccrue": {
"type": "number",
"format": "double",
"nullable": true
},
"defaultCalendarYearMaxBalance": {
"type": "number",
"format": "double",
"nullable": true
},
"defaultPeriodMaxAccrue": {
"type": "number",
"format": "double",
"nullable": true
},
"defaultPeriodMaxBalance": {
"type": "number",
"format": "double",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.AdjustmentAuthoritiesListQuery.Result": {
"type": "object",
"properties": {
"authorityId": {
"type": "integer",
"format": "int32"
},
"authority": {
"type": "string",
"nullable": true
},
"requiresCaseNumber": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.AdjustmentCategoriesList.Result": {
"type": "object",
"properties": {
"category": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"billable": {
"type": "boolean"
},
"adjustsNet": {
"type": "boolean"
},
"adjustsGross": {
"type": "boolean"
},
"isBenefit": {
"type": "boolean"
},
"isEWA": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.AdjustmentDefaultRuleCasesQuery.Result": {
"type": "object",
"properties": {
"ruleColumnId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"ruleConstraintTypeId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"ruleComparisonValue": {
"type": "number",
"format": "double",
"nullable": true
},
"takeValueAsPercentOfColumnId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"takeValue": {
"type": "number",
"format": "double"
},
"takeMaximumValue": {
"type": "number",
"format": "double",
"nullable": true
},
"takeMaximumValueAsPercentOfColumnId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"takeAllOrNothing": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.AdjustmentFrequenciesListQuery.Result": {
"type": "object",
"properties": {
"frequencyId": {
"type": "string",
"format": "uuid"
},
"frequency": {
"type": "string",
"nullable": true
},
"payPeriods": {
"type": "integer",
"format": "int32"
},
"isDefault": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.AdjustmentRuleCaseRuleColumnsListQuery.Result": {
"type": "object",
"properties": {
"ruleColumnId": {
"type": "string",
"format": "uuid"
},
"ruleColumn": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.AdjustmentRuleCaseRuleConstraintTypesListQuery.Result": {
"type": "object",
"properties": {
"ruleConstraintTypeId": {
"type": "string",
"format": "uuid"
},
"ruleConstraintType": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.AssignmentStatusListQuery.Result": {
"type": "object",
"properties": {
"assignmentStatusId": {
"type": "integer",
"format": "int32"
},
"assignmentStatus": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.BackgroundCheckStatusTypesList.Result": {
"type": "object",
"properties": {
"backgroundCheckStatusId": {
"type": "integer",
"format": "int32"
},
"backgroundCheckStatus": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.BankAccountListQuery.Result": {
"type": "object",
"properties": {
"bankAccountId": {
"type": "integer",
"format": "int32"
},
"bankName": {
"type": "string",
"nullable": true
},
"bankAccountDescription": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.BatchJobItemStatusList.Result": {
"type": "object",
"properties": {
"batchJobItemStatusId": {
"type": "integer",
"format": "int64"
},
"batchJobItemStatus": {
"type": "string",
"nullable": true
},
"isAwaitingProcessing": {
"type": "boolean"
},
"isBeingProcessed": {
"type": "boolean"
},
"hasBeenProcessed": {
"type": "boolean"
},
"hasFailed": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.BillingFrequencyListQuery.Result": {
"type": "object",
"properties": {
"billingFrequencyId": {
"type": "string",
"format": "uuid"
},
"billingFrequency": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.BiometricsImageAngleListQuery.Result": {
"type": "object",
"properties": {
"angleId": {
"type": "integer",
"format": "int32"
},
"angle": {
"type": "string",
"nullable": true
},
"active": {
"type": "boolean"
},
"required": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.ColorComboList.Result": {
"type": "object",
"properties": {
"colorComboId": {
"type": "integer",
"format": "int32"
},
"primaryColor": {
"type": "string",
"nullable": true
},
"primaryColorCode": {
"type": "string",
"nullable": true
},
"primaryFontCode": {
"type": "string",
"nullable": true
},
"accentColor": {
"type": "string",
"nullable": true
},
"accentColorCode": {
"type": "string",
"nullable": true
},
"accentFontCode": {
"type": "string",
"nullable": true
},
"isDefault": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.CommissionCreditTypeListQuery.Result": {
"type": "object",
"properties": {
"creditTypeId": {
"type": "integer",
"format": "int32"
},
"creditTypeName": {
"type": "string",
"nullable": true
},
"isRecruiter": {
"type": "boolean"
},
"isSales": {
"type": "boolean"
},
"defaultCommissionBase": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.ContactRoleListQuery.Result": {
"type": "object",
"properties": {
"contactRoleId": {
"type": "integer",
"format": "int32"
},
"contactRole": {
"type": "string",
"nullable": true
},
"isUniquePerCustomer": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.ContactStatusListQuery.Result": {
"type": "object",
"properties": {
"contactStatusId": {
"type": "string",
"nullable": true
},
"contactStatus": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.CreditHoldCodeListQuery.Result": {
"type": "object",
"properties": {
"holdCode": {
"type": "string",
"nullable": true
},
"holdDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.CurrenciesListQuery.Result": {
"type": "object",
"properties": {
"currencyId": {
"type": "integer",
"format": "int32"
},
"currencyName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.CustomDataPropertyTypeQuery.Result": {
"type": "object",
"properties": {
"propertyType": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.CustomDataSupportedOriginTypesQuery.Result": {
"type": "object",
"properties": {
"originTypeId": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.CustomerInvoiceLineItemDetailListQuery.Result": {
"type": "object",
"properties": {
"invoiceLineItemDetailId": {
"type": "string",
"nullable": true
},
"invoiceLineItemDetail": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.CustomerTypeListQuery.Result": {
"type": "object",
"properties": {
"customerTypeId": {
"type": "integer",
"format": "int32"
},
"typeName": {
"type": "string",
"nullable": true
},
"typeDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.ElectronicPayAccountTypesListQuery.Result": {
"type": "object",
"properties": {
"accountType": {
"type": "string",
"nullable": true
},
"accountTypeId": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.ElectronicPayBankTypesListQuery.Result": {
"type": "object",
"properties": {
"electronicPayBankTypeId": {
"type": "integer",
"format": "int32"
},
"electronicPayBankType": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.EmailAccountsList.Result": {
"type": "object",
"properties": {
"accountId": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"senderEmail": {
"type": "string",
"nullable": true
},
"senderName": {
"type": "string",
"nullable": true
},
"defaultSignatureId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"defaultSignatureGuid": {
"type": "string",
"format": "uuid",
"nullable": true
},
"serviceTypeId": {
"type": "integer",
"format": "int32"
},
"defaultSignatureName": {
"type": "string",
"nullable": true
},
"isSystem": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.EmailServiceTypesList.Result": {
"type": "object",
"properties": {
"serviceTypeId": {
"type": "integer",
"format": "int32"
},
"serviceType": {
"type": "string",
"nullable": true
},
"requiresExternalServiceId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"requiresExternalService": {
"type": "string",
"nullable": true
},
"setupIsComplete": {
"type": "boolean"
},
"authorizeUrl": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.EmailSignaturesList.Result": {
"type": "object",
"properties": {
"signatureId": {
"type": "integer",
"format": "int32"
},
"signatureGuid": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"signature": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.InterviewQuestionCategoryList.Result": {
"type": "object",
"properties": {
"categoryId": {
"type": "string",
"format": "uuid"
},
"category": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.InterviewQuestionTypeList.Result": {
"type": "object",
"properties": {
"questionTypeId": {
"type": "integer",
"format": "int32"
},
"questionType": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.InterviewQuestionsByCategoryIdList.Result": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"format": "uuid"
},
"questionName": {
"type": "string",
"nullable": true
},
"questionText": {
"type": "string",
"nullable": true
},
"questionDescription": {
"type": "string",
"nullable": true
},
"possibleAnswers": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"categoryId": {
"type": "string",
"format": "uuid"
},
"category": {
"type": "string",
"nullable": true
},
"questionTypeId": {
"type": "integer",
"format": "int32"
},
"questionType": {
"type": "string",
"nullable": true
},
"isRequired": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.InvoiceEmailTemplateListQuery.Result": {
"type": "object",
"properties": {
"invoiceEmailTemplateId": {
"type": "string",
"format": "uuid"
},
"invoiceEmailTemplate": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.InvoiceHandlingListQuery.Result": {
"type": "object",
"properties": {
"invoiceHandlingCode": {
"type": "integer",
"format": "int32"
},
"invoiceHandlingDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.InvoiceReportListQuery.Result": {
"type": "object",
"properties": {
"invoiceReportId": {
"type": "string",
"format": "uuid"
},
"invoiceReport": {
"type": "string",
"nullable": true
},
"invoiceReportPath": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.JobOrderCandidateStatusListQuery.Result": {
"type": "object",
"properties": {
"jobOrderCandidateStatusId": {
"type": "integer",
"format": "int32"
},
"jobOrderCandidateStatus": {
"type": "string",
"nullable": true
},
"jobOrderCandidateStatusDescription": {
"type": "string",
"nullable": true
},
"isDefault": {
"type": "boolean"
},
"impliesActive": {
"type": "boolean"
},
"offerStatusTypeId": {
"$ref": "#/components/schemas/TwApi.Common.Enums.OfferStatusType"
},
"offerStatusType": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.JobOrderDurationListQuery.Result": {
"type": "object",
"properties": {
"jobOrderDurationId": {
"type": "integer",
"format": "int32"
},
"jobOrderDuration": {
"type": "string",
"nullable": true
},
"workDays": {
"type": "number",
"format": "double"
},
"calendarDays": {
"type": "number",
"format": "double"
},
"isDefault": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.JobOrderStatusListQuery.Result": {
"type": "object",
"properties": {
"jobOrderStatusId": {
"type": "integer",
"format": "int32"
},
"jobOrderStatus": {
"type": "string",
"nullable": true
},
"jobOrderStatusDescription": {
"type": "string",
"nullable": true
},
"impliesJobOrderIsActive": {
"type": "boolean"
},
"impliesJobOrderIsUnfilled": {
"type": "boolean"
},
"impliesJobOrderIsDeleted": {
"type": "boolean"
},
"impliesJobOrderIsLost": {
"type": "boolean"
},
"impliesJobOrderIsPending": {
"type": "boolean"
},
"impliesJobOrderIsClosed": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.KpiReportTypesList.Result": {
"type": "object",
"properties": {
"reportTypeId": {
"type": "integer",
"format": "int32"
},
"reportType": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.MaritalTaxStatusListQuery.Result": {
"type": "object",
"properties": {
"maritalTaxStatusId": {
"type": "integer",
"format": "int32"
},
"maritalTaxStatus": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.MonthlyBillCycleListQuery.Result": {
"type": "object",
"properties": {
"monthlyBillCycleId": {
"type": "integer",
"format": "int32"
},
"monthlyBillCycle": {
"type": "string",
"nullable": true
},
"isValidForBiWeeklyBilling": {
"type": "boolean"
},
"isValidForMonthlyBilling": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.MonthlyPayCyclesListByPayPeriodQuery.Result": {
"type": "object",
"properties": {
"monthlyPayCycleId": {
"type": "integer",
"format": "int32"
},
"monthlyPayCycle": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.MonthlyPayCyclesListQuery.Result": {
"type": "object",
"properties": {
"monthlyPayCycleId": {
"type": "integer",
"format": "int32"
},
"monthlyPayCycle": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.NationalIndustryClassificationSystemCodeListQuery.Result": {
"type": "object",
"properties": {
"nationalIndustryClassificationSystemCode": {
"type": "integer",
"format": "int32",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"dateDeactivated": {
"type": "string",
"format": "date-time",
"nullable": true
},
"mergedWithNationalIndustryClassificationSystemCode": {
"type": "integer",
"format": "int32",
"nullable": true
},
"active": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.PayCodeListQuery.Result": {
"type": "object",
"properties": {
"payCodeId": {
"type": "integer",
"format": "int32"
},
"payCode": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"isDefault": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.PayTransparencyCollectionTypeBasisListQuery.Result": {
"type": "object",
"properties": {
"payTransparencyCollectionTypeBasisId": {
"type": "integer",
"format": "int32"
},
"state": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.PayTransparencyCollectionTypeListQuery.Result": {
"type": "object",
"properties": {
"payTransparencyCollectionTypeId": {
"type": "integer",
"format": "int32"
},
"state": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"requiresBasis": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.PayTransparencyGenderListQuery.Result": {
"type": "object",
"properties": {
"payTransparencyGenderId": {
"type": "integer",
"format": "int32"
},
"state": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.PayTransparencyRaceListQuery.Result": {
"type": "object",
"properties": {
"payTransparencyRaceId": {
"type": "integer",
"format": "int32"
},
"state": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.PaycheckDeliveryCodeListQuery.Result": {
"type": "object",
"properties": {
"paycheckDeliveryCode": {
"type": "string",
"nullable": true
},
"paycheckDeliveryCodeDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.ProspectStatusList.Result": {
"type": "object",
"properties": {
"prospectStatusId": {
"type": "integer",
"format": "int64"
},
"prospectStatus": {
"type": "string",
"nullable": true
},
"isDefaultStatus": {
"type": "boolean"
},
"isProspectActive": {
"type": "boolean"
},
"isActive": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.RemoteWorkStatusListQuery.Result": {
"type": "object",
"properties": {
"remoteWorkStatusId": {
"type": "integer",
"format": "int32"
},
"state": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.ResumeFileTypeList.Result": {
"type": "object",
"properties": {
"fileType": {
"type": "string",
"nullable": true
},
"fileDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.ResumeTemplateListQuery.Result": {
"type": "object",
"properties": {
"specialReportId": {
"type": "string",
"format": "uuid"
},
"reportName": {
"type": "string",
"nullable": true
},
"reportPath": {
"type": "string",
"nullable": true
},
"specialReportTypeId": {
"type": "string",
"format": "uuid"
},
"specialReportTypeName": {
"type": "string",
"nullable": true
},
"hierId": {
"type": "integer",
"format": "int32"
},
"hierName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.RoutingNumbersListQuery.Result": {
"type": "object",
"properties": {
"electronicPayBankTypeId": {
"type": "integer",
"format": "int32"
},
"routingNumber": {
"type": "string",
"nullable": true
},
"bankName": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.SalesPipelineStatusListQuery.Result": {
"type": "object",
"properties": {
"salesPipelineStatusId": {
"type": "string",
"format": "uuid"
},
"salesPipelineStatus": {
"type": "string",
"nullable": true
},
"minPipelineProgress": {
"type": "integer",
"format": "int32"
},
"maxPipelineProgress": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.SalesTaxTypesList.Result": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"description": {
"type": "string",
"nullable": true
},
"isDefault": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.ServiceRepTeamListQuery.Result": {
"type": "object",
"properties": {
"teamId": {
"type": "integer",
"format": "int32"
},
"teamName": {
"type": "string",
"nullable": true
},
"teamOwnerSrIdent": {
"type": "integer",
"format": "int32"
},
"teamOwner": {
"type": "string",
"nullable": true
},
"teamGuid": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.ServiceRepTeamMembersListQuery.Result": {
"type": "object",
"properties": {
"teamMemberId": {
"type": "integer",
"format": "int32"
},
"teamMemberSrIdent": {
"type": "integer",
"format": "int32"
},
"teamMember": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.ShiftList.Result": {
"type": "object",
"properties": {
"shiftId": {
"type": "string",
"format": "uuid"
},
"shift": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"startTime": {
"type": "string",
"format": "date-time"
},
"endTime": {
"type": "string",
"format": "date-time"
},
"shiftNotes": {
"type": "string",
"nullable": true
},
"isScheduledForSunday": {
"type": "boolean"
},
"isScheduledForMonday": {
"type": "boolean"
},
"isScheduledForTuesday": {
"type": "boolean"
},
"isScheduledForWednesday": {
"type": "boolean"
},
"isScheduledForThursday": {
"type": "boolean"
},
"isScheduledForFriday": {
"type": "boolean"
},
"isScheduledForSaturday": {
"type": "boolean"
},
"minutesOfBreakPerDay": {
"type": "number",
"format": "double"
},
"defaultLevelId": {
"type": "string",
"format": "uuid"
},
"levelDescription": {
"type": "string",
"nullable": true
},
"originId": {
"type": "integer",
"format": "int64"
},
"originPrimaryDetail": {
"type": "string",
"nullable": true
},
"originSecondaryDetail": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.SmtpEncryptionMethodsList.Result": {
"type": "object",
"properties": {
"encryptionMethodId": {
"type": "integer",
"format": "int32"
},
"encryptionMethod": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.SovrenJobBoardsList.Result": {
"type": "object",
"properties": {
"jobBoardId": {
"type": "integer",
"format": "int32"
},
"jobBoard": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.TemplateCategoryList.Result": {
"type": "object",
"properties": {
"templateCategoryId": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.TemplateCategoryTemplatesList.Result": {
"type": "object",
"properties": {
"templateId": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"template": {
"type": "string",
"nullable": true
},
"templateSubject": {
"type": "string",
"nullable": true
},
"templateTypeId": {
"type": "string",
"format": "uuid"
},
"templateType": {
"type": "string",
"nullable": true
},
"templateDataSourceId": {
"type": "string",
"format": "uuid"
},
"templateDataSource": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.TemplateDataSourcesList.Result": {
"type": "object",
"properties": {
"templateDataSourceId": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"targetOriginTypeId": {
"type": "integer",
"format": "int32"
},
"targetOriginType": {
"type": "string",
"nullable": true
},
"referenceOriginTypeId": {
"type": "integer",
"format": "int32"
},
"referenceOriginType": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.TemplateTypeList.Result": {
"type": "object",
"properties": {
"templateTypeId": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"templateCategoryId": {
"type": "string",
"format": "uuid"
},
"templateCategory": {
"type": "string",
"nullable": true
},
"targetOriginTypeId": {
"type": "integer",
"format": "int32"
},
"targetOriginType": {
"type": "string",
"nullable": true
},
"referenceOriginTypeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"referenceOriginType": {
"type": "string",
"nullable": true
},
"defaultTemplateDataSourceId": {
"type": "string",
"format": "uuid"
},
"defaultTemplateDataSource": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.TextMessageProviderList.Result": {
"type": "object",
"properties": {
"providerId": {
"type": "integer",
"format": "int32"
},
"providerName": {
"type": "string",
"nullable": true
},
"emailSuffix": {
"type": "string",
"nullable": true
},
"isNorthAmericanDefault": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Datalists.Service.Commands.TimeClockTimeZoneListQuery.Result": {
"type": "object",
"properties": {
"timeClockTimeZoneId": {
"type": "string",
"format": "uuid"
},
"timeZoneAbbreviation": {
"type": "string",
"nullable": true
},
"timeZone": {
"type": "string",
"nullable": true
},
"timeZoneOffset": {
"type": "integer",
"format": "int32"
},
"isDaylightSavingsTime": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Email.API.Models.CreateTestEmailRequest": {
"required": [
"format"
],
"type": "object",
"properties": {
"emailAccount": {
"$ref": "#/components/schemas/TwApi.Messages.EmailAccounts.EmailAccountDetailsResult"
},
"emailAccountId": {
"type": "integer",
"description": "The Id of the Email Account.",
"format": "int32",
"nullable": true
},
"to": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Email.API.Models.CreateTestEmailRequest.EmailAddress"
},
"description": "List of addresses for the To portion of an email.",
"nullable": true
},
"subject": {
"type": "string",
"description": "The Subject of the Email.",
"nullable": true
},
"body": {
"type": "string",
"description": "Body of the message. Populated when the message is an adhoc template or is not a mass email.",
"nullable": true
},
"format": {
"$ref": "#/components/schemas/TwApi.Common.Enums.EmailFormat"
},
"sensitivity": {
"$ref": "#/components/schemas/TwApi.Common.Enums.MsExchangeSensitivity"
},
"correlationId": {
"type": "string",
"description": "Optional user defined unique identifier.",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false,
"description": "The Request object for emails."
},
"TwApi.Services.Email.API.Models.CreateTestEmailRequest.EmailAddress": {
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "The Email address to use. When null, the OriginType and OriginId will be used to lookup the primary email address.",
"nullable": true
},
"name": {
"type": "string",
"description": "Optional string value for the Name.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Email Address for a recipient."
},
"TwApi.Services.Email.Service.Commands.GetEmailBatchEmails.Result": {
"type": "object",
"properties": {
"correlationId": {
"type": "string",
"format": "uuid"
},
"emailSessionId": {
"type": "string",
"format": "uuid"
},
"errorMessage": {
"type": "string",
"nullable": true
},
"emailSessionStatusId": {
"type": "integer",
"format": "int32"
},
"emailSessionStatus": {
"type": "string",
"nullable": true
},
"contactMessageId": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"nullable": true
},
"messageDate": {
"type": "string",
"format": "date-time"
},
"messageLink": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageLink"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Email.Service.Commands.OrchestrateCreateEmail.Result": {
"type": "object",
"properties": {
"correlationId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"TwApi.Services.Email.Service.Commands.SendTestEmail.Result": {
"type": "object",
"properties": {
"correlationId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"TwApi.Services.Email.Service.Commands.SentEmailBatches.Result": {
"type": "object",
"properties": {
"correlationId": {
"type": "string",
"format": "uuid"
},
"emailCount": {
"type": "integer",
"format": "int32"
},
"emailsQueued": {
"type": "integer",
"format": "int32"
},
"emailsSent": {
"type": "integer",
"format": "int32"
},
"emailsFailed": {
"type": "integer",
"format": "int32"
},
"emailsPartiallyFailed": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Email.Service.Commands.SmtpAutoDiscover.Result": {
"type": "object",
"properties": {
"username": {
"type": "string",
"nullable": true
},
"host": {
"type": "string",
"nullable": true
},
"port": {
"type": "integer",
"format": "int32"
},
"secureSocketOption": {
"type": "integer",
"format": "int32"
},
"smtpLog": {
"type": "string",
"nullable": true
},
"hasError": {
"type": "boolean"
},
"errorMessage": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Email.Service.Commands.TestSmtpCredentials.Result": {
"type": "object",
"properties": {
"errorType": {
"type": "integer",
"format": "int32"
},
"smtpLog": {
"type": "string",
"nullable": true
},
"hasError": {
"type": "boolean"
},
"errorMessage": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.API.Models.AcaHireEmployeeRequest": {
"required": [
"acaEmploymentStatusId",
"acaHireDate"
],
"type": "object",
"properties": {
"acaHireDate": {
"type": "string",
"description": "Employee's hire date for ACA tracking purposes.\r\nThe date format is ISO 8601 YYYY-MM-DD.",
"format": "date-time"
},
"acaEmploymentStatusId": {
"type": "string",
"description": "A list of ACA Employment statuses can be found in the ACA Employment Statuses datalist.",
"format": "uuid"
},
"employmentStatusReasoning": {
"type": "string",
"description": "Optional text field - use to describe why the specified ACA Employment Status was selected.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to indicate when an Employee was hired for ACA tracking purposes."
},
"TwApi.Services.Employees.API.Models.AcaUpdateEmployeeStatusRequest": {
"required": [
"acaEmploymentStatusId",
"acaHireDate"
],
"type": "object",
"properties": {
"acaHireDate": {
"type": "string",
"description": "Employee's hire date for ACA tracking purposes.\r\nThe date format is ISO 8601 YYYY-MM-DD.",
"format": "date-time"
},
"acaEmploymentStatusId": {
"type": "string",
"description": "A list of ACA Employment statuses can be found in the ACA Employment Statuses datalist.",
"format": "uuid"
},
"employmentStatusReasoning": {
"type": "string",
"description": "Optional text field - use to describe why the specified ACA Employment Status was selected.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to update the employment status of the employee for ACA tracking purposes."
},
"TwApi.Services.Employees.API.Models.AnswerPair": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"description": "The id of the question",
"format": "uuid"
},
"answer": {
"type": "string",
"description": "The answer to the question",
"nullable": true
}
},
"additionalProperties": false,
"description": "An answer/question id pair"
},
"TwApi.Services.Employees.API.Models.AssignEmployeeInterviewCategoriesRequest": {
"required": [
"categoriesToAssign"
],
"type": "object",
"properties": {
"categoriesToAssign": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Valid Category Ids can be found in the Interview Question Categories Datalist."
}
},
"additionalProperties": false,
"description": "A request to add an create an interview for an employee."
},
"TwApi.Services.Employees.API.Models.CreateEeoRequest": {
"type": "object",
"properties": {
"birthPlace": {
"type": "string",
"description": "The place the employee was born.",
"nullable": true
},
"dateOfBirth": {
"type": "string",
"description": "The date the employee was born.\r\nThe date format is ISO 8601 YYYY-MM-DD.",
"format": "date-time",
"nullable": true
},
"genderId": {
"type": "integer",
"description": "The gender of the employee. A list of genders can be found at the datalists/genders endpoint.",
"format": "int32",
"nullable": true
},
"i9DateVerified": {
"type": "string",
"description": "The date the employee's I-9 was verified.\r\nThe date format is ISO 8601 YYYY-MM-DD.",
"format": "date-time",
"nullable": true
},
"isCitizen": {
"type": "boolean",
"description": "Indicates whether or not the employee is a citizen.",
"nullable": true
},
"isDisabled": {
"type": "boolean",
"description": "Indicates whether or not the employee is disabled."
},
"isEVerified": {
"type": "boolean",
"description": "Indicates whether or not the employee's employment status has been verified with E-Verify."
},
"nationalityId": {
"type": "integer",
"description": "Employee's Nationality. Valid Nationalities can be found in the Nationalities Datalist.",
"format": "int32",
"nullable": true
},
"veteranStatusId": {
"type": "integer",
"description": "Employee's Veteran Status. Valid Veteran Statuses can be found in the Veteran Statuses Datalist.",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to create an EEO record for an Employee."
},
"TwApi.Services.Employees.API.Models.CreateEmployeeAccrualRequest": {
"required": [
"accrualId",
"accrualTiers",
"annualDepletionRolloverDate",
"isActive"
],
"type": "object",
"properties": {
"accrualId": {
"type": "string",
"description": "The Accrual Id",
"format": "uuid"
},
"isActive": {
"type": "boolean",
"description": "Indicates if the accrual is active."
},
"applyOnlyWhenAssignmentHasMatchingAccrual": {
"type": "boolean",
"description": "If true, this accrual is only applied if it is also set up on the assignment.",
"nullable": true
},
"applyOnlyWhenCustomerHasMatchingAccrual": {
"type": "boolean",
"description": "If true, this accrual is only applied if it is also set up on the customer.",
"nullable": true
},
"annualDepletionRolloverDate": {
"type": "string",
"description": "Date when depletion limits reset.",
"format": "date-time"
},
"accrualTiers": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeAccrualTier"
},
"description": "A collection of one or more tiers."
}
},
"additionalProperties": false,
"description": "A request to create an Accrual for an Employee."
},
"TwApi.Services.Employees.API.Models.CreateEmployeeAccrualTier": {
"required": [
"accrualRate",
"accrualTierId",
"depletionRate",
"effectiveDate",
"tierActive"
],
"type": "object",
"properties": {
"accrualTierId": {
"type": "string",
"description": "The accrual tier Id",
"format": "uuid"
},
"accrualRate": {
"type": "number",
"description": "Accrual rate per pay period.",
"format": "double"
},
"depletionRate": {
"type": "number",
"description": "Depletion rate per pay period.",
"format": "double"
},
"periodMaxAccrue": {
"type": "number",
"description": "Maximum amount that can be accrued per pay period. Leave null if there is no maximum amount.",
"format": "double",
"nullable": true
},
"calendarYearMaxAccrue": {
"type": "number",
"description": "Maximum amount that can be accrued per calendar year. Leave null if there is no maximum amount.",
"format": "double",
"nullable": true
},
"periodMaxBalance": {
"type": "number",
"description": "Maximum accrual balance that can be carried over after a pay period. Leave null if there is no maximum amount.",
"format": "double",
"nullable": true
},
"calendarYearMaxBalance": {
"type": "number",
"description": "Maximum accrual balance that can be carried over after a calendar year. Leave null if there is no maximum amount.",
"format": "double",
"nullable": true
},
"anniversaryMaxBalance": {
"type": "number",
"description": "Maximum accrual balance that can be carried over after the employee's anniversary date. Leave null if there is no maximum amount.",
"format": "double",
"nullable": true
},
"effectiveDate": {
"type": "string",
"description": "Date when the tier takes effect.",
"format": "date-time"
},
"tierActive": {
"type": "boolean",
"description": "Indicates if the accrual tier is active."
}
},
"additionalProperties": false,
"description": "Request object to create an employee accrual tier."
},
"TwApi.Services.Employees.API.Models.CreateEmployeeAdjustmentRequest": {
"required": [
"adjustmentId",
"deductGreatestRuleCase",
"frequencyId"
],
"type": "object",
"properties": {
"adjustmentId": {
"type": "integer",
"description": "Id of the adjustment type. Valid adjustment types can be found in the Adjustments datalist.",
"format": "int32"
},
"employerId": {
"type": "integer",
"description": "Id of the employer this adjustment should be linked to. Valid employers can be found in the Employers datalist.",
"format": "int32",
"nullable": true
},
"sequence": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"description": "Optional - specify a sequence for this adjustment. Adjustments with no sequence are calculated simultaneously, then adjustments with a sequence are calculated in ascending order (sequence 1, then sequence 2, etc).",
"format": "int32",
"nullable": true
},
"description": {
"maxLength": 100,
"minLength": 0,
"type": "string",
"description": "A description of the adjustment.",
"nullable": true
},
"frequencyId": {
"type": "string",
"description": "Frequency with which the adjustment should be applied. Influences adjustment calculation during payroll - adjustments will actually be applied on each check. Valid frequencies can be found in the Adjustment Frequencies datalist.",
"format": "uuid"
},
"dateServed": {
"type": "string",
"description": "Use to record when a garnishment, child support, or similar order was served.\r\nThe date format is ISO 8601 YYYY-MM-DD.",
"format": "date-time",
"nullable": true
},
"startDate": {
"type": "string",
"description": "If specified, the adjustment will not deduct on checks processed prior to this date.\r\nThe date format is ISO 8601 YYYY-MM-DD.",
"format": "date-time",
"nullable": true
},
"endDate": {
"type": "string",
"description": "If specified, the adjustment will not deduct on checks processed after this date.\r\nThe date format is ISO 8601 YYYY-MM-DD.",
"format": "date-time",
"nullable": true
},
"authorityId": {
"type": "integer",
"description": "Authority ordering the adjustment. Valid authorities can be found in the Adjustment Authorities datalist.",
"format": "int32",
"nullable": true
},
"caseNumber": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "The case number for the adjustment if any.",
"nullable": true
},
"note": {
"maxLength": 1000,
"minLength": 0,
"type": "string",
"description": "A note field.",
"nullable": true
},
"maximumLifetimeTakeAmount": {
"minimum": 0,
"type": "number",
"description": "The maximum amount that can ever be collected for the adjustment.",
"format": "double",
"nullable": true
},
"maximumYearlyTakeAmount": {
"minimum": 0,
"type": "number",
"description": "The maximum amount that can be collected every calendar year for the adjustment.",
"format": "double",
"nullable": true
},
"maximumMonthlyTakeAmount": {
"minimum": 0,
"type": "number",
"description": "The maximum amount that can be collected every month for the adjustment.",
"format": "double",
"nullable": true
},
"maximumPerPeriodTakeAmount": {
"minimum": 0,
"type": "number",
"description": "The maximum amount that can be collected every pay period for the adjustment.",
"format": "double",
"nullable": true
},
"minimumRemainingAfterCalculation": {
"minimum": 0,
"type": "number",
"description": "If specified, the adjustment will not reduce the net of a paycheck below the specified amount.",
"format": "double",
"nullable": true
},
"routingNumber": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Bank Routing Number - Use for secondary direct deposit adjustments. Valid Routing Numbers can be found in the Routing Numbers Datalist.",
"nullable": true
},
"accountNumber": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Bank Account Number - Use for secondary direct deposit adjustments.",
"nullable": true
},
"accountTypeId": {
"maxLength": 3,
"minLength": 0,
"type": "string",
"description": "Use for secondary direct deposit adjustments to indicate what kind of account this is. Valid Electronic Pay Account Types can be found in the Electronic Pay Account Types Datalist.",
"nullable": true
},
"datePreNoteSent": {
"type": "string",
"description": "DatePreNoteSent cannot be after DatePreNoteApproved or DatePreNoteDisapproved.",
"format": "date-time",
"nullable": true
},
"datePreNoteApproved": {
"type": "string",
"description": "If DatePreNoteApproved is specified, DatePreNoteDisapproved must not be specified.",
"format": "date-time",
"nullable": true
},
"datePreNoteDisapproved": {
"type": "string",
"description": "If DatePreNoteDisapproved is specified, DatePreNoteApproved must not be specified.",
"format": "date-time",
"nullable": true
},
"misc1": {
"maxLength": 25,
"minLength": 0,
"type": "string",
"description": "A field for miscellaneous data.",
"nullable": true
},
"misc2": {
"maxLength": 25,
"minLength": 0,
"type": "string",
"description": "A field for miscellaneous data.",
"nullable": true
},
"misc3": {
"maxLength": 25,
"minLength": 0,
"type": "string",
"description": "A field for miscellaneous data.",
"nullable": true
},
"monthlyPayCycleId": {
"type": "integer",
"description": "A field for do indicate which week the adjustment should be taken out of an employee's paycheck if collected monthly. A list of values\r\ncan be found at the datalists/monthlyPayCycles endpoint.",
"format": "int32",
"nullable": true
},
"deductGreatestRuleCase": {
"type": "boolean",
"description": "If true and this adjustment has multiple rule cases, payroll calculations will use the rule case that results in the highest deduction."
},
"levyDependents": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "The number of dependents to account for when calculating the amount of a levy adjustment. If the adjustment is a levy, this field is required, otherwise it must be null or 0.",
"format": "int32",
"nullable": true
},
"ruleCases": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.CreateEmployeeAdjustmentRuleCaseRequest"
},
"description": "A collection of one or more rules that define how much an adjustment should deduct under various circumstances.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to create an Adjustment for an Employee."
},
"TwApi.Services.Employees.API.Models.CreateEmployeeAdjustmentRuleCaseRequest": {
"required": [
"takeValue"
],
"type": "object",
"properties": {
"ruleColumnId": {
"type": "string",
"description": "Works with RuleConstraintTypeId and RuleComparisonValue to determine whether the adjustment should use this rule. Defines what\r\ntype of pay the constraint should compare to (ex gross or net). Valid rule columns can be found in the Adjustment Rule Case Columns datalist.",
"format": "uuid",
"nullable": true
},
"ruleConstraintTypeId": {
"type": "string",
"description": "Works with RuleColumnId and RuleComparisonValue to determine whether the adjustment should use this rule. Defines a constraint\r\ntype to compare with (ex less than, greater than). Valid rule constraint types can be found in the Adjustment Rule Case Constraint Types datalist.",
"format": "uuid",
"nullable": true
},
"ruleComparisonValue": {
"type": "number",
"description": "Works with RuleColumnId and RuleConstraintTypeId to determine whether the adjustment should use this rule. Ex calculate only if\r\ngross is greater than 200.",
"format": "double",
"nullable": true
},
"takeValueAsPercentOfColumnId": {
"type": "string",
"description": "If specified, the adjustment will deduct the TakeValue as a percentage of a type of pay (ex 50% of gross pay). Valid rule columns\r\ncan be found in the Adjustment Rule Case Columns datalist.",
"format": "uuid",
"nullable": true
},
"takeValue": {
"type": "number",
"description": "How much the adjustment should deduct.",
"format": "double"
},
"takeMaximumValue": {
"type": "number",
"description": "If specified, adjustment will deduct no more than this amount.",
"format": "double",
"nullable": true
},
"takeMaximumValueAsPercentOfColumnId": {
"type": "string",
"description": "If specified, the adjustment will deduct no more than TakeMaximumValue as a percentage of a type of pay (ex no more than 50% of gross). Valid rule columns can be found in the Adjustment Rule Case Columns datalist.",
"format": "uuid",
"nullable": true
},
"takeAllOrNothing": {
"type": "boolean",
"description": "If true, the adjustment will only deduct if the entire TakeValue can be deducted."
}
},
"additionalProperties": false,
"description": "A request to create an adjustment rule case."
},
"TwApi.Services.Employees.API.Models.CreateEmployeeDoNotAssignRequest": {
"type": "object",
"properties": {
"customerId": {
"type": "integer",
"description": "The id of the customer which the employee requested not to be assigned to.",
"format": "int64"
},
"isInitiatedByCustomer": {
"type": "boolean",
"description": "Specifies whether the customer has initiated the \"do not assign\" restriction."
},
"isInitiatedByEmployee": {
"type": "boolean",
"description": "Specifies whether the employee has initiated the \"do not assign\" restriction."
},
"isForAllDepartments": {
"type": "boolean",
"description": "Specifies whether the \"do not assign\" restriction should apply to all departments of the customer."
},
"message": {
"type": "string",
"description": "The reason for the \"do not assign\" restriction.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request of an employee not to be assign to a customer."
},
"TwApi.Services.Employees.API.Models.CreateEmployeeEducationRequest": {
"type": "object",
"properties": {
"bypassAddressValidationService": {
"type": "boolean",
"description": "If true, bypasses validating that the address against the United State Postal Service database."
},
"includeInBackgroundChecks": {
"type": "boolean",
"description": "If true, the education item will be included when performing background checks that utilize education details."
},
"institutionAttended": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "The name of the educational institution attended.",
"nullable": true
},
"degreeAwarded": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "The type of degree or program attended",
"nullable": true
},
"enrollmentStatus": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "The enrollment or completion status",
"nullable": true
},
"other": {
"type": "string",
"description": "A field for notes or other comments.",
"nullable": true
},
"grade": {
"type": "number",
"description": "Maps back to GPA on employeeeducation.",
"format": "double",
"nullable": true
},
"dateAttendedStart": {
"type": "string",
"description": "Maps back to DatesAttendedStart on employeeeducation.\r\nThe date format is ISO 8601 YYYY-MM-DD.",
"format": "date-time",
"nullable": true
},
"dateAttendedEnd": {
"type": "string",
"description": "Maps back to DatesAttendedEnd on employeeeducation.\r\nThe recommended date Format is ISO 8601 YYYY-MM-DD.",
"format": "date-time",
"nullable": true
},
"degreeDate": {
"type": "string",
"description": "The date the degree was awarded if any.\r\nThe recommended date Format is ISO 8601 YYYY-MM-DD.",
"format": "date-time",
"nullable": true
},
"major": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "The major/focus of the education.",
"nullable": true
},
"contactInformation": {
"maxLength": 1000,
"minLength": 0,
"type": "string",
"description": "Contact information for the institution.",
"nullable": true
},
"street1": {
"maxLength": 255,
"type": "string",
"description": "This is the main street address. I.E. 1234 Main St.",
"nullable": true
},
"street2": {
"maxLength": 255,
"type": "string",
"description": "This is the secondary part of the address reserved for things such as identifying suite or apartment numbers.",
"nullable": true
},
"municipality": {
"maxLength": 255,
"type": "string",
"description": "The city/municipality of the address.",
"nullable": true
},
"region": {
"maxLength": 5,
"type": "string",
"description": "The state/region of the address.",
"nullable": true
},
"postalCode": {
"maxLength": 255,
"type": "string",
"description": "The postal code of the address.",
"nullable": true
},
"countryCode": {
"type": "integer",
"description": "The Id of the country. Valid countries can be found in the Countries datalist.",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to create an Education record on an Employee."
},
"TwApi.Services.Employees.API.Models.CreateEmployeeInterestCodeRequest": {
"required": [
"interestCodeId",
"isValidated"
],
"type": "object",
"properties": {
"interestCodeId": {
"type": "integer",
"description": "Id for the new interest code. Valid Interest Code Ids can be found in the Interest Codes Datalist.",
"format": "int32"
},
"years": {
"type": "number",
"description": "How long the employee has had this skill.",
"format": "double",
"nullable": true
},
"note": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "A field for notes.",
"nullable": true
},
"isValidated": {
"type": "boolean",
"description": "Indicates whether or not the interest code has been verified. This may be used in the cases where employees self report skills with\r\nexperience."
}
},
"additionalProperties": false,
"description": "A request to add an Interest Code to an Employee"
},
"TwApi.Services.Employees.API.Models.CreateEmployeeInterviewRequest": {
"required": [
"categoriesToAssign",
"interviewName"
],
"type": "object",
"properties": {
"categoriesToAssign": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Valid Category Ids can be found in the Interview Question Categories Datalist."
},
"interviewName": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "The interview name."
}
},
"additionalProperties": false,
"description": "A request to create an interview for an employee."
},
"TwApi.Services.Employees.API.Models.CreateEmployeeReferenceRequest": {
"required": [
"bypassAddressValidationService"
],
"type": "object",
"properties": {
"name": {
"maxLength": 100,
"minLength": 0,
"type": "string",
"description": "The name of the person serving as a reference.\r\nDEPRECATED - Use FirstName and LastName instead.",
"nullable": true
},
"phoneNumber": {
"maxLength": 256,
"minLength": 0,
"type": "string",
"description": "A phone number to contact the reference.",
"nullable": true
},
"phoneNumberCountryCallingCode": {
"type": "integer",
"description": "Country Calling Code for phone number. Valid Country Calling Codes can be found in the Country Calling Codes Datalist.",
"format": "int32",
"nullable": true
},
"email": {
"maxLength": 256,
"minLength": 0,
"type": "string",
"description": "An email address to contact the reference.",
"nullable": true
},
"relationship": {
"maxLength": 256,
"minLength": 0,
"type": "string",
"description": "The relationship between the reference and the employee.",
"nullable": true
},
"companyName": {
"maxLength": 200,
"minLength": 0,
"type": "string",
"description": "The name of the company the reference belongs to.",
"nullable": true
},
"dateReferenceChecked": {
"type": "string",
"description": "The date the referenced was checked.\r\nThe date format is ISO 8601 YYYY-MM-DD.",
"format": "date-time",
"nullable": true
},
"dateReferenceSent": {
"type": "string",
"description": "The date a request for reference was sent.\r\nThe date format is ISO 8601 YYYY-MM-DD.",
"format": "date-time",
"nullable": true
},
"workHistoryId": {
"type": "integer",
"description": "The work history item to link the reference to. Valid values can be found at /employees/{id}/WorkHistory",
"format": "int32",
"nullable": true
},
"isOkayToContact": {
"type": "boolean",
"description": "Is it okay to contact this reference?"
},
"includeInBackgroundChecks": {
"type": "boolean",
"description": "Should this reference be included in background checks?"
},
"firstName": {
"maxLength": 50,
"type": "string",
"description": "The first name of the person serving as a reference.",
"nullable": true
},
"lastName": {
"maxLength": 50,
"type": "string",
"description": "The last name of the person serving as a reference.",
"nullable": true
},
"referenceType": {
"maxLength": 50,
"type": "string",
"description": "The type of reference i.e. Personal, Professional",
"nullable": true
},
"street1": {
"maxLength": 255,
"type": "string",
"description": "This is the main street address. I.E. 1234 Main St.",
"nullable": true
},
"street2": {
"maxLength": 255,
"type": "string",
"description": "This is the secondary part of the address reserved for things such as identifying suite or apartment numbers.",
"nullable": true
},
"municipality": {
"maxLength": 255,
"type": "string",
"description": "The city/municipality of the address.",
"nullable": true
},
"region": {
"maxLength": 5,
"type": "string",
"description": "The state/region of the address.",
"nullable": true
},
"postalCode": {
"maxLength": 255,
"type": "string",
"description": "The postal code of the address.",
"nullable": true
},
"countryCode": {
"type": "integer",
"description": "Previous employer's country code - A list of valid country codes can be found in the Country Codes datalist.",
"format": "int32",
"nullable": true
},
"bypassAddressValidationService": {
"type": "boolean",
"description": "If true, address validation will be bypassed and the address will save as long as all other validation passes."
},
"notes": {
"maxLength": 2500,
"minLength": 0,
"type": "string",
"description": "The reference Notes.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to create a Reference record for an Employee."
},
"TwApi.Services.Employees.API.Models.CreateEmployeeRequest": {
"required": [
"branchId",
"countryCode",
"firstName",
"lastName",
"region"
],
"type": "object",
"properties": {
"firstName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "The employee's first name."
},
"lastName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "The employee's second name."
},
"governmentPersonalId": {
"type": "string",
"description": "The government identifier of the employee. \r\nThis value would be an SSN when the countrycode is 840 (US), NI No for 826 (UK), and SIN for 124 (Canada). The countrycode of the request will define which is used. Maps back to SSN in the database for US and Canadian employees or Identifier in the EmployeeIdentifier table in the database for UK employees.",
"nullable": true
},
"bypassAddressValidationService": {
"type": "boolean",
"description": "If true, address validation will be bypassed and the address will save as long as all other validation passes.\r\nDefaults to true."
},
"street1": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Maps back to Address in the database.",
"nullable": true
},
"street2": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Maps back to Address2 in the database.",
"nullable": true
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Maps back to City in the database.",
"nullable": true
},
"region": {
"maxLength": 5,
"minLength": 0,
"type": "string",
"description": "The Id of the region. Valid regions can be found in the Regions datalist. Maps back to State in the database."
},
"branchId": {
"type": "integer",
"description": "The Id of the branch the employee will be linked to. Valid branches can be found in the Branches datalist.",
"format": "int32"
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"type": "string",
"description": "Maps back to Zip in the database.",
"nullable": true
},
"primaryEmailAddress": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "The primary email address the employee should be contacted at.",
"nullable": true
},
"primaryPhoneNumber": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "The primary phone number the employee should be contacted at.",
"nullable": true
},
"primaryPhoneNumberCountryCallingCode": {
"type": "integer",
"description": "The country calling code the phone number will be associated with. This is required when the phone number is specified. \r\nValid country calling codes can be found in the CountryCallingCodes datalist.",
"format": "int32",
"nullable": true
},
"cellPhoneNumber": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "A cell phone number.",
"nullable": true
},
"cellPhoneNumberCountryCallingCode": {
"type": "integer",
"description": "The country calling code the cell phone number will be associated with. This is required when the cell phone number is specified. \r\nValid country calling codes can be found in the CountryCallingCodes datalist.",
"format": "int32",
"nullable": true
},
"countryCode": {
"type": "integer",
"description": "The Id of the country. This will default to the country code of the branch if not defined. Valid countries can be found in the Countries datalist.",
"format": "int32"
},
"schoolDistrictCode": {
"type": "integer",
"description": "The employee's school district code.",
"format": "int32",
"nullable": true
},
"schoolJurisId": {
"type": "integer",
"description": "The employee's school juris id.",
"format": "int32",
"nullable": true
},
"psdCode": {
"maxLength": 10,
"minLength": 0,
"type": "string",
"description": "The PSDCode. Used for addresses in Pennsylvania.",
"nullable": true
},
"howHeardOfId": {
"type": "integer",
"description": "The Id of the how heard of the employee will be linked to. Valid how heard of's can be found in the HowHeardOf datalist.",
"format": "int32",
"nullable": true
},
"createWithDefaultWebApplicantStatuses": {
"type": "boolean",
"description": "Indicates whether the employee should be created with default web applicant statuses.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to create an Employee."
},
"TwApi.Services.Employees.API.Models.CreateEmployeeRequiredDocumentRequest": {
"required": [
"active",
"requiredDocumentAuthorityId",
"requiredDocumentTypeId"
],
"type": "object",
"properties": {
"requiredDocumentAuthorityId": {
"type": "integer",
"description": "The required document authority identifier.",
"format": "int32"
},
"requiredDocumentTypeId": {
"type": "integer",
"description": "The required document type identifier.",
"format": "int32"
},
"active": {
"type": "boolean",
"description": "A flag specifying whether or not additional warnings about this document should be displayed to the user."
},
"notes": {
"maxLength": 1000,
"minLength": 0,
"type": "string",
"description": "The notes field supplying additional document information.",
"nullable": true
},
"expirationDate": {
"type": "string",
"description": "The expiration date for this employee required document.",
"format": "date-time",
"nullable": true
},
"issuedDate": {
"type": "string",
"description": "The issued date for this employee required document.",
"format": "date-time",
"nullable": true
},
"requestedDate": {
"type": "string",
"description": "The requested date for this employee required document.",
"format": "date-time",
"nullable": true
},
"receivedDate": {
"type": "string",
"description": "The received date for this employee required document.",
"format": "date-time",
"nullable": true
},
"licenseNumber": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "The license number.",
"nullable": true
},
"requiredDocumentStatusId": {
"type": "string",
"description": "The status identifier.",
"format": "uuid",
"nullable": true
},
"documentId": {
"type": "integer",
"description": "The document identifier linked with this required document.",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request model class for creating an employeee required document."
},
"TwApi.Services.Employees.API.Models.CreateEmployeeTaxRequest": {
"required": [
"additionalAllowances",
"additionalWithholdingAmount",
"allowances",
"isExempt",
"taxAmount",
"taxJurisdictionId",
"taxPercentage"
],
"type": "object",
"properties": {
"taxJurisdictionId": {
"type": "integer",
"description": "The employee tax jurisdiction Id.",
"format": "int32"
},
"taxAmount": {
"maximum": 1000000000,
"minimum": -1000000000,
"type": "number",
"description": "The employee tax amount.",
"format": "double"
},
"taxPercentage": {
"maximum": 1,
"minimum": 0,
"type": "number",
"description": "The employee tax percentage.",
"format": "double"
},
"allowances": {
"maximum": 255,
"minimum": 0,
"type": "integer",
"description": "The employee tax allowances.",
"format": "int32"
},
"isExempt": {
"type": "boolean",
"description": "A flag specifying whether or not the employee tax is exempt."
},
"employerId": {
"type": "integer",
"description": "The employee tax employer Id.",
"format": "int32",
"nullable": true
},
"additionalAllowances": {
"maximum": 255,
"minimum": 0,
"type": "integer",
"description": "The employee tax additional allowances.",
"format": "int32"
},
"additionalWithholdingAmount": {
"maximum": 1000000000,
"minimum": -1000000000,
"type": "number",
"description": "The employee tax additional withholding amount.",
"format": "double"
},
"alternativeStandardDeduction": {
"maximum": 1000000000,
"minimum": 0.01,
"type": "number",
"description": "Alternative standard deduction. Allowed only for TaxJurisdictions with TwApi.Shared.Commands.Datalists.TaxJurisdictionListQuery.Result.UsesAlternativeStandardDeduction=true",
"format": "double",
"nullable": true
},
"dependents": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "The number of dependants the employee claims.",
"format": "int32"
}
},
"additionalProperties": false,
"description": "A request model to create a tax for an employee."
},
"TwApi.Services.Employees.API.Models.CreateEmployeeWebUserRequest": {
"required": [
"password",
"username"
],
"type": "object",
"properties": {
"username": {
"maxLength": 254,
"minLength": 0,
"type": "string",
"description": "The Web User's Username"
},
"password": {
"maxLength": 100,
"minLength": 7,
"type": "string",
"description": "The Password the Web User will use to login."
},
"automaticallyLinkProductInstances": {
"type": "boolean",
"description": "Optional Parameter.\r\nIf true, ProductInstanceId and RoleId parameters will be ignored and the Web User will be linked to product instances based on the Api User's current hierarchy.",
"nullable": true
},
"hrCenterProductInstanceId": {
"type": "string",
"description": "The Product Instance Id for the HRCenter instance the Web User will log into.\r\nA list of instances is available at Datalists/productInstances. Use the ProductId of 8 to get HRCenter instances.",
"format": "uuid",
"nullable": true
},
"webCenterProductInstanceId": {
"type": "string",
"description": "The Product Instance Id for the Web Center instance the Web User will log into.\r\nA list of instances is available at Datalists/productInstances. Use the ProductId of 4 to get Web Center instances.",
"format": "uuid",
"nullable": true
},
"webCenterRoleId": {
"type": "string",
"description": "The Role Id for the user to use when logging into Web Center.\r\nUse the Employees/{employeeId}/webUser/webCenter/availableRoles endpoint to get a list of available roles.",
"format": "uuid",
"nullable": true
},
"companionProductInstanceId": {
"type": "string",
"description": "The Product Instance for the Companion instance the Web User will log into.\r\nA list of instances is available at Datalists/productInstances. Use the ProductId of 16 to get Web Center instances.",
"format": "uuid",
"nullable": true
},
"jobBoardProductInstanceId": {
"type": "string",
"description": "The Product Instance for the Job Board instance the Web User will log into.\r\nA list of instances is available at Datalists/productInstances. Use the ProductId of 32 to get Web Center instances.",
"format": "uuid",
"nullable": true
},
"tempWorksMobileAppProductInstanceId": {
"type": "string",
"description": "The Product Instance for the TempWorks Mobile App instance the Web User will log into.\r\nA list of instances is available at Datalists/productInstances. Use the ProductId of 512 to get TempWorks Mobile App instances.",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false,
"description": "A Request Passed into the API to initiate the creation of a Web User for an Employee"
},
"TwApi.Services.Employees.API.Models.CreateEmployeeWorkHistoryRequest": {
"required": [
"bypassAddressValidationService",
"includeInBackgroundChecks",
"isFullTime",
"isOkayToContact",
"isPartTime",
"isTemporaryJob"
],
"type": "object",
"properties": {
"startDate": {
"type": "string",
"description": "The date the employee started the job.\r\nThe date format is ISO 8601 YYYY-MM-DD.",
"format": "date-time",
"nullable": true
},
"endDate": {
"type": "string",
"description": "The date the employee ended the job.\r\nThe date format is ISO 8601 YYYY-MM-DD.",
"format": "date-time",
"nullable": true
},
"employer": {
"maxLength": 50,
"type": "string",
"description": "The employer the employee worked for.",
"nullable": true
},
"street1": {
"maxLength": 255,
"type": "string",
"description": "This is the main street address. I.E. 1234 Main St.",
"nullable": true
},
"street2": {
"maxLength": 255,
"type": "string",
"description": "This is the secondary part of the address reserved for things such as identifying suite or apartment numbers.",
"nullable": true
},
"municipality": {
"maxLength": 255,
"type": "string",
"description": "The city/municipality of the address.",
"nullable": true
},
"region": {
"maxLength": 5,
"type": "string",
"description": "The state/region of the address.",
"nullable": true
},
"postalCode": {
"maxLength": 255,
"type": "string",
"description": "The postal code of the address.",
"nullable": true
},
"countryCode": {
"type": "integer",
"description": "Previous employer's country code - A list of valid country codes can be found in the Country Codes datalist.",
"format": "int32",
"nullable": true
},
"phoneNumber": {
"maxLength": 255,
"type": "string",
"description": "Maps to Phone in the database.",
"nullable": true
},
"phoneNumberCountryCallingCode": {
"type": "integer",
"description": "Previous employer's country calling code - A list of valid country calling codes can be found in the Country Calling Codes datalist.",
"format": "int32",
"nullable": true
},
"position": {
"maxLength": 50,
"type": "string",
"description": "Maps to Pos in the database.",
"nullable": true
},
"pay": {
"maxLength": 50,
"type": "string",
"description": "The amount the employee was paid.",
"nullable": true
},
"isFullTime": {
"type": "boolean",
"description": "Maps to FT in the database."
},
"isPartTime": {
"type": "boolean",
"description": "Maps to PT in the database."
},
"isTemporaryJob": {
"type": "boolean",
"description": "Maps to TempJob in the database."
},
"duties": {
"maxLength": 1000,
"type": "string",
"description": "The duties the employee was expected to perform.",
"nullable": true
},
"supervisor": {
"maxLength": 50,
"type": "string",
"description": "The name of the employee's supervisor at the job.\r\nDEPRECATED - use SupervisorFirstName and SupervisorLastName fields instead.",
"nullable": true
},
"reasonForLeaving": {
"maxLength": 1000,
"type": "string",
"description": "Maps to Reason in the database.",
"nullable": true
},
"isOkayToContact": {
"type": "boolean",
"description": "If true, it is okay to contact this employer."
},
"includeInBackgroundChecks": {
"type": "boolean",
"description": "If true, this job will be included in background checks on the employee."
},
"supervisorFirstName": {
"maxLength": 255,
"type": "string",
"description": "The first name of the employee's supervisor at the job.",
"nullable": true
},
"supervisorLastName": {
"maxLength": 255,
"type": "string",
"description": "The last name of the employee's supervisor at the job.",
"nullable": true
},
"supervisorTitle": {
"maxLength": 255,
"type": "string",
"description": "The title of the employee's supervisor at the job.",
"nullable": true
},
"supervisorEmail": {
"maxLength": 255,
"type": "string",
"description": "The email address of the employee's supervisor at the job.",
"nullable": true
},
"bypassAddressValidationService": {
"type": "boolean",
"description": "If true, address validation will be bypassed and the address will save as long as all other validation passes."
}
},
"additionalProperties": false,
"description": "A request to create a Work History record for an Employee."
},
"TwApi.Services.Employees.API.Models.CreateInviteLinkRequest": {
"type": "object",
"properties": {
"redirectUrl": {
"maxLength": 255,
"type": "string",
"description": "Optional redirect url to redirect the user to after they complete registration.",
"nullable": true
},
"webCenterRoleId": {
"type": "string",
"description": "Optional Web Center Role Id to link the web user account to.",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"TwApi.Services.Employees.API.Models.CreateJobOrderJobBoardCandidate": {
"required": [
"employeeId"
],
"type": "object",
"properties": {
"employeeId": {
"type": "integer",
"description": "The Id of the employee. A list of employees can be found at search/employees.",
"format": "int64"
},
"utmSource": {
"maxLength": 255,
"type": "string",
"description": "The UTM source.",
"nullable": true
},
"utmCampaign": {
"maxLength": 255,
"type": "string",
"description": "The UTM campaign.",
"nullable": true
},
"utmMedium": {
"maxLength": 255,
"type": "string",
"description": "The UTM medium.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to make a Employee a Candidate on a Job Board Job Order."
},
"TwApi.Services.Employees.API.Models.CreatePayTransparencyRequest": {
"type": "object",
"properties": {
"state": {
"maxLength": 5,
"minLength": 1,
"type": "string",
"description": "Abbreivated geographical state of employee",
"nullable": true
},
"payTransparencyRaceId": {
"type": "integer",
"description": "Id of Employee's race",
"format": "int32",
"nullable": true
},
"racePayTransparencyCollectionTypeId": {
"type": "integer",
"description": "How the race of the employee was collected.",
"format": "int32",
"nullable": true
},
"racePayTransparencyCollectionTypeBasisId": {
"type": "integer",
"description": "What the race of the employee is determined from (applies if collection method requires a basis to judge from)",
"format": "int32",
"nullable": true
},
"payTransparencyGenderId": {
"type": "integer",
"description": "Id of Employee's gender",
"format": "int32",
"nullable": true
},
"genderPayTransparencyCollectionTypeId": {
"type": "integer",
"description": "How the gender of the employee was collected.",
"format": "int32",
"nullable": true
},
"genderPayTransparencyCollectionTypeBasisId": {
"type": "integer",
"description": "What the gender of the employee is determined from (applies if collection method requires a basis to judge from)",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to update an existing PayTransparency record for an Employee."
},
"TwApi.Services.Employees.API.Models.EmployeeAvailability": {
"required": [
"availabilityStatusId",
"date"
],
"type": "object",
"properties": {
"availabilityStatusId": {
"maximum": 3,
"minimum": 1,
"type": "integer",
"description": "Must be one of: \r\n1 - Available,\r\n2 - Partially available (PartialTimes specify when),\r\n3 - Unavailable",
"format": "int32"
},
"note": {
"maxLength": 250,
"minLength": 0,
"type": "string",
"description": "Optional, must not exceed 250 characters.",
"nullable": true
},
"partialTimes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeAvailabilitySpan"
},
"description": "Used only when availability status is set to partially available. \r\nSpecifies a set of times when the employee is available.",
"nullable": true
},
"date": {
"type": "string",
"description": "The date of the single-day availability record. Not used for recurrence.",
"format": "date"
}
},
"additionalProperties": false,
"description": "A request to create an availability record for an employee."
},
"TwApi.Services.Employees.API.Models.EmployeeAvailabilityRecurrence": {
"required": [
"availabilityStatusId",
"recurrenceEndDate",
"recurrenceStartDate",
"recursEveryXWeeks"
],
"type": "object",
"properties": {
"availabilityStatusId": {
"maximum": 3,
"minimum": 1,
"type": "integer",
"description": "Must be one of: \r\n1 - Available,\r\n2 - Partially available (PartialTimes specify when),\r\n3 - Unavailable",
"format": "int32"
},
"note": {
"maxLength": 250,
"minLength": 0,
"type": "string",
"description": "Optional, must not exceed 250 characters.",
"nullable": true
},
"partialTimes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.EmployeeAvailabilitySpan"
},
"description": "Used only when availability status is set to partially available. \r\nSpecifies a set of times when the employee is available.",
"nullable": true
},
"recurrenceStartDate": {
"type": "string",
"description": "The start date of the recurring availability record. Not used for single-day availability.",
"format": "date"
},
"recurrenceEndDate": {
"type": "string",
"description": "The end date of the recurring availability record. Not used for single-day availability.",
"format": "date"
},
"recursEveryXWeeks": {
"type": "integer",
"description": "Required for reccuring availability. Ignored for single-day availability.",
"format": "int32"
},
"recursOnSunday": {
"type": "boolean",
"description": "Indicates whether or not the availability recurs on Sunday.",
"nullable": true
},
"recursOnMonday": {
"type": "boolean",
"description": "Indicates whether or not the availability recurs on Monday.",
"nullable": true
},
"recursOnTuesday": {
"type": "boolean",
"description": "Indicates whether or not the availability recurs on Tuesday.",
"nullable": true
},
"recursOnWednesday": {
"type": "boolean",
"description": "Indicates whether or not the availability recurs on Wednesday.",
"nullable": true
},
"recursOnThursday": {
"type": "boolean",
"description": "Indicates whether or not the availability recurs on Thursday.",
"nullable": true
},
"recursOnFriday": {
"type": "boolean",
"description": "Indicates whether or not the availability recurs on Friday.",
"nullable": true
},
"recursOnSaturday": {
"type": "boolean",
"description": "Indicates whether or not the availability recurs on Saturday.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to create a availability records based on recurring conditions."
},
"TwApi.Services.Employees.API.Models.EmployeeAvailabilitySpan": {
"required": [
"endTime",
"startTime"
],
"type": "object",
"properties": {
"startTime": {
"type": "string",
"description": "The start of the availability period.",
"format": "date-span"
},
"endTime": {
"type": "string",
"description": "The end of the availability period.",
"format": "date-span"
}
},
"additionalProperties": false,
"description": "A time span during which the employee is available."
},
"TwApi.Services.Employees.API.Models.EmployeeBranchHierarchyRequest": {
"type": "object",
"properties": {
"branchId": {
"type": "integer",
"description": "Branch id",
"format": "int32"
},
"hierTypeId": {
"type": "integer",
"description": "Hierarchy type id",
"format": "int32"
}
},
"additionalProperties": false,
"description": "Model for updating employee branch and hierarchy type"
},
"TwApi.Services.Employees.API.Models.EmployeeCreateValidationRequest": {
"required": [
"branchId",
"countryCode",
"firstName",
"lastName",
"region"
],
"type": "object",
"properties": {
"propertiesToValidate": {
"type": "array",
"items": {
"type": "string"
},
"description": "",
"nullable": true
},
"firstName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "The employee's first name."
},
"lastName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "The employee's second name."
},
"governmentPersonalId": {
"type": "string",
"description": "The government identifier of the employee. \r\nThis value would be an SSN when the countrycode is 840 (US), NI No for 826 (UK), and SIN for 124 (Canada). The countrycode of the request will define which is used. Maps back to SSN in the database for US and Canadian employees or Identifier in the EmployeeIdentifier table in the database for UK employees.",
"nullable": true
},
"bypassAddressValidationService": {
"type": "boolean",
"description": "If true, address validation will be bypassed and the address will save as long as all other validation passes.\r\nDefaults to true."
},
"street1": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Maps back to Address in the database.",
"nullable": true
},
"street2": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Maps back to Address2 in the database.",
"nullable": true
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Maps back to City in the database.",
"nullable": true
},
"region": {
"maxLength": 5,
"minLength": 0,
"type": "string",
"description": "The Id of the region. Valid regions can be found in the Regions datalist. Maps back to State in the database."
},
"branchId": {
"type": "integer",
"description": "The Id of the branch the employee will be linked to. Valid branches can be found in the Branches datalist.",
"format": "int32"
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"type": "string",
"description": "Maps back to Zip in the database.",
"nullable": true
},
"primaryEmailAddress": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "The primary email address the employee should be contacted at.",
"nullable": true
},
"primaryPhoneNumber": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "The primary phone number the employee should be contacted at.",
"nullable": true
},
"primaryPhoneNumberCountryCallingCode": {
"type": "integer",
"description": "The country calling code the phone number will be associated with. This is required when the phone number is specified. \r\nValid country calling codes can be found in the CountryCallingCodes datalist.",
"format": "int32",
"nullable": true
},
"cellPhoneNumber": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "A cell phone number.",
"nullable": true
},
"cellPhoneNumberCountryCallingCode": {
"type": "integer",
"description": "The country calling code the cell phone number will be associated with. This is required when the cell phone number is specified. \r\nValid country calling codes can be found in the CountryCallingCodes datalist.",
"format": "int32",
"nullable": true
},
"countryCode": {
"type": "integer",
"description": "The Id of the country. This will default to the country code of the branch if not defined. Valid countries can be found in the Countries datalist.",
"format": "int32"
},
"schoolDistrictCode": {
"type": "integer",
"description": "The employee's school district code.",
"format": "int32",
"nullable": true
},
"schoolJurisId": {
"type": "integer",
"description": "The employee's school juris id.",
"format": "int32",
"nullable": true
},
"psdCode": {
"maxLength": 10,
"minLength": 0,
"type": "string",
"description": "The PSDCode. Used for addresses in Pennsylvania.",
"nullable": true
},
"howHeardOfId": {
"type": "integer",
"description": "The Id of the how heard of the employee will be linked to. Valid how heard of's can be found in the HowHeardOf datalist.",
"format": "int32",
"nullable": true
},
"createWithDefaultWebApplicantStatuses": {
"type": "boolean",
"description": "Indicates whether the employee should be created with default web applicant statuses.",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"TwApi.Services.Employees.API.Models.EmployeeInterviewAnswerRequest": {
"type": "object",
"properties": {
"answer": {
"maxLength": 1000,
"minLength": 0,
"type": "string",
"description": "The interview answer.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request containing parameters for the employee candidacies resource"
},
"TwApi.Services.Employees.API.Models.EmployeeInviteWebUserRequest": {
"required": [
"emailAddress",
"webCenterRoleId"
],
"type": "object",
"properties": {
"emailAddress": {
"minLength": 1,
"type": "string",
"description": "The email address of the user to invite to be a web user. If there is an existing email on file this will be ignored. If not a new email value will be saved as the email on file."
},
"webCenterRoleId": {
"type": "string",
"description": "The web center role of the invite.",
"format": "uuid"
}
},
"additionalProperties": false,
"description": "A request to invite an employee web user."
},
"TwApi.Services.Employees.API.Models.EmployeeLastFourCharsGovIdAndLastNameDuplicateRequest": {
"required": [
"branchId",
"lastFourCharsGovId",
"lastName",
"productInstanceId"
],
"type": "object",
"properties": {
"lastFourCharsGovId": {
"minLength": 1,
"type": "string",
"description": "The last four government identifier characters."
},
"lastName": {
"minLength": 1,
"type": "string",
"description": "The employee's last name."
},
"productInstanceId": {
"type": "string",
"description": "The product instance identifier.",
"format": "uuid"
},
"branchId": {
"type": "integer",
"description": "The employee's branch identifier.",
"format": "int32"
}
},
"additionalProperties": false,
"description": "The validate request for duplicate employee by last four government identifier characters and last name combination."
},
"TwApi.Services.Employees.API.Models.GetDuplicateGovernmentPersonalIdsRequest": {
"required": [
"countryCode",
"governmentPersonalId",
"lastName"
],
"type": "object",
"properties": {
"employeeId": {
"type": "integer",
"description": "The ID of the employee being updated.",
"format": "int64",
"nullable": true
},
"countryCode": {
"type": "integer",
"description": "The numeric country code of the employee being created/updated.",
"format": "int32"
},
"governmentPersonalId": {
"minLength": 1,
"type": "string",
"description": "The government personal identifier for the employee being created/updated. This value would an SSN when the countrycode is 840 (US), NI No for 826 (UK), and SIN for 124 (Canada)."
},
"lastName": {
"minLength": 1,
"type": "string",
"description": "The last name of the employee being created/updated."
},
"branchId": {
"type": "integer",
"description": "The branch of the employee being created/updated. Setting the BranchId will restrict results to employees that are in that branch.",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": "Find duplicate employees based on GovernmentPersonalIdAndLastName."
},
"TwApi.Services.Employees.API.Models.InsertManualAccrualRequest": {
"required": [
"amount",
"isAccrual",
"isDeplete",
"weekendDate"
],
"type": "object",
"properties": {
"amount": {
"type": "number",
"description": "Accrual amount to add or remove from the accrual.",
"format": "double"
},
"isAccrual": {
"type": "boolean",
"description": "If true, the manual accrual amount will be included in calculations against period and annual maximum accrual limits.\r\nIsAccrual and IsDeplete cannot be true at the same time."
},
"isDeplete": {
"type": "boolean",
"description": "If true, the manual accrual amount will count against annual depletion limits. IsAccrual and IsDeplete cannot be true at the same time."
},
"weekendDate": {
"type": "string",
"description": "Weekend date to apply this manual accrual to. Must be a Sunday date.",
"format": "date-time"
},
"notes": {
"maxLength": 1000,
"minLength": 0,
"type": "string",
"description": "Note field for the manual accrual.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Request object for creating a manual accrual"
},
"TwApi.Services.Employees.API.Models.MergeEmployeeRequest": {
"type": "object",
"properties": {
"employeeId": {
"type": "integer",
"description": "Employee Id of target employee",
"format": "int64"
},
"mergeAddress": {
"type": "boolean",
"description": "Set to true to merge address"
},
"mergeBasicDetails": {
"type": "boolean",
"description": "Set to true to merge basic details (first name, middle name, last name)"
},
"mergeAssignmentsPayHistory": {
"type": "boolean",
"description": "Set to true to merge assignments, checks, and accruals"
},
"mergeBasicTaxSetup": {
"type": "boolean",
"description": "Set to true to merge basic tax setup (inc. federal and state allowances)"
},
"mergeContactMethods": {
"type": "boolean",
"description": "Set to true to merge contact methods"
},
"mergeCustomData": {
"type": "boolean",
"description": "Set to true to merge custom data values"
},
"mergeDocuments": {
"type": "boolean",
"description": "Set to true to merge documents and required documents"
},
"mergeEducation": {
"type": "boolean",
"description": "Set to true to merge education"
},
"mergeInterestCodes": {
"type": "boolean",
"description": "Set to true to merge interest codes"
},
"mergeInterviews": {
"type": "boolean",
"description": "Set to true to merge interviews"
},
"mergeMessages": {
"type": "boolean",
"description": "Set to true to merge logged messages"
},
"mergeTests": {
"type": "boolean",
"description": "Set to true to merge tests"
},
"mergeWorkHistory": {
"type": "boolean",
"description": "Set to true to merge work history and references"
},
"useCustomMerge": {
"type": "boolean",
"description": "Set to true to use custom merge (UMergeAidentCustomProcedure ConfigType).\r\nIf set to true when the config is not populated with a valid procedure, an error is thrown."
}
},
"additionalProperties": false,
"description": "Model for merging a source employee into a target employee"
},
"TwApi.Services.Employees.API.Models.SearchEmployeeCandidaciesRequest": {
"required": [
"skip",
"take"
],
"type": "object",
"properties": {
"jobOrderCandidateStatusIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "If provided, searches for candidacies with a CandidateStatusId that is included in the provided array.\r\nIf this parameter is null or an empty array, the results will not be filtered by status.",
"nullable": true
},
"orderBy": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.OrderByColumn"
},
"description": "Used to order the results by one or more of the returned columns.",
"nullable": true
},
"skip": {
"type": "integer",
"description": "The number of candidacies to skip. Used for paging.",
"format": "int32"
},
"take": {
"type": "integer",
"description": "The number of candidacies to return. Used for paging.",
"format": "int32"
},
"restrictToActiveCandidacies": {
"type": "boolean",
"description": "If set to true only active candidates will be returned. If not set, both active and inactive candidates will be returned."
}
},
"additionalProperties": false,
"description": "A request containing parameters for the employee candidacies search"
},
"TwApi.Services.Employees.API.Models.UpdateEeoRequest": {
"type": "object",
"properties": {
"birthPlace": {
"type": "string",
"description": "The place the employee was born.",
"nullable": true
},
"dateOfBirth": {
"type": "string",
"description": "The date the employee was born.\r\nThe date format is ISO 8601 YYYY-MM-DD.",
"format": "date-time",
"nullable": true
},
"genderId": {
"type": "integer",
"description": "The gender of the employee. A list of genders can be found at the datalists/genders endpoint.",
"format": "int32",
"nullable": true
},
"i9DateVerified": {
"type": "string",
"description": "The date the employee's I-9 was verified.\r\nThe date format is ISO 8601 YYYY-MM-DD.",
"format": "date-time",
"nullable": true
},
"isCitizen": {
"type": "boolean",
"description": "Indicates whether or not the employee is a citizen.",
"nullable": true
},
"isDisabled": {
"type": "boolean",
"description": "Indicates whether or not the employee is disabled."
},
"isEVerified": {
"type": "boolean",
"description": "Indicates whether or not the employee's employment status has been verified with E-Verify."
},
"nationalityId": {
"type": "integer",
"description": "Employee's Nationality. Valid Nationalities can be found in the Nationalities Datalist.",
"format": "int32",
"nullable": true
},
"veteranStatusId": {
"type": "integer",
"description": "Employee's Veteran Status. Valid Veteran Statuses can be found in the Veteran Statuses Datalist.",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to update an existing EEO record for an Employee."
},
"TwApi.Services.Employees.API.Models.UpdateElectronicPayBankAccountRequestModel": {
"required": [
"accountTypeId",
"routingNumber"
],
"type": "object",
"properties": {
"accountTypeId": {
"minLength": 1,
"type": "string",
"description": "Defines which type the bank account is. \r\nValid values can be found at datalists/electronicPayAccountTypes.\r\nMaps to ChkOrSav in the database."
},
"routingNumber": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "The routing number for the bank account. A list of values can be found at datalists/routingNumbers"
},
"accountNumber": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "If Account Number is not set during an update, the account number of the record is not changed.\r\nThis value may not be available if the user does not have permission to read the account number on the bank record.",
"nullable": true
},
"preNoteSent": {
"type": "string",
"description": "A date indicating when the account was included in a PreNote file to the bank.",
"format": "date-time",
"nullable": true
},
"preNoteApproved": {
"type": "string",
"description": "A date indicating when the account bank approved the PreNote.",
"format": "date-time",
"nullable": true
},
"preNoteDisapproved": {
"type": "string",
"description": "A date indicating when the account bank declined the PreNote.",
"format": "date-time",
"nullable": true
},
"roleNumber": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "RoleNumber used when the Bank Account is BACS (UK)",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to update the Direct Deposit Bank Account information for an Employee"
},
"TwApi.Services.Employees.API.Models.UpdateElectronicPayPaycardAccountRequestModel": {
"required": [
"paycardVendorId"
],
"type": "object",
"properties": {
"paycardVendorId": {
"type": "integer",
"description": "Vendor supplying the paycard. Valid Paycard Vendors can be found in the Paycard Vendors Datalist.",
"format": "int32"
},
"paycardDateVerified": {
"type": "string",
"description": "Specifies that the paycard is valid and ready to be used in payroll when populated.\r\nThis value is read only when paycardVendorId = 4 (ADP).",
"format": "date-time",
"nullable": true
},
"paycardVerifiedByServiceRepId": {
"type": "integer",
"description": "Specifies which service rep verified the paycard.\r\nThis value is read only when paycardVendorId = 4 (ADP).",
"format": "int32",
"nullable": true
},
"expirationDate": {
"type": "string",
"description": "The Expiration date of the paycard.\r\nThis value is read only when paycardVendorId = 4 (ADP).\r\nThe date format is ISO 8601 YYYY-MM-DD.",
"format": "date-time",
"nullable": true
},
"accountNumber": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "The account number to be used during funding of the paycard.\r\nThis value is read only when paycardVendorId = 4 (ADP).\r\nIf Account Number is not set during an update, the account number of the record is not changed.\r\nThis value may not be available if the user does not have permission to read the account number on the bank record.",
"nullable": true
},
"routingNumber": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "The routing number to be used during funding of the paycard.\r\nThis value is read only when paycardVendorId = 4 (ADP).",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to update the Paycard Account for an employee."
},
"TwApi.Services.Employees.API.Models.UpdateElectronicPayRequest": {
"required": [
"electronicPayBankTypeId"
],
"type": "object",
"properties": {
"isActive": {
"type": "boolean",
"description": "Determines if the employee electronic pay is active and to be used in payroll processing."
},
"electronicPayBankTypeId": {
"type": "integer",
"description": "Determines which bank type the employee will use when electronic payments are processed. A list of available electronic bank types can be found at the datalists/electronicBankTypes endpoint.",
"format": "int32"
}
},
"additionalProperties": false,
"description": "A request to change what type of electronic pay method will be used by the employee."
},
"TwApi.Services.Employees.API.Models.UpdateEmployeeAccrualRequest": {
"required": [
"accrualId",
"accrualTiers",
"annualDepletionRolloverDate",
"isActive"
],
"type": "object",
"properties": {
"accrualId": {
"type": "string",
"description": "The Accrual Id",
"format": "uuid"
},
"isActive": {
"type": "boolean",
"description": "Indicates if the accrual is active."
},
"applyOnlyWhenAssignmentHasMatchingAccrual": {
"type": "boolean",
"description": "If true, this accrual is only applied if it is also set up on the assignment.",
"nullable": true
},
"applyOnlyWhenCustomerHasMatchingAccrual": {
"type": "boolean",
"description": "If true, this accrual is only applied if it is also set up on the customer.",
"nullable": true
},
"annualDepletionRolloverDate": {
"type": "string",
"description": "Date when depletion limits reset.",
"format": "date-time"
},
"accrualTiers": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeAccrualTier"
},
"description": "A collection of one or more tiers."
}
},
"additionalProperties": false,
"description": "A request to update an Accrual for an Employee."
},
"TwApi.Services.Employees.API.Models.UpdateEmployeeAccrualTier": {
"required": [
"accrualRate",
"accrualTierId",
"depletionRate",
"effectiveDate",
"tierActive"
],
"type": "object",
"properties": {
"employeeAccrualTierId": {
"type": "string",
"description": "Employee accrual tier id.",
"format": "uuid",
"nullable": true
},
"accrualTierId": {
"type": "string",
"description": "The accrual tier Id",
"format": "uuid"
},
"accrualRate": {
"type": "number",
"description": "Accrual rate per pay period.",
"format": "double"
},
"depletionRate": {
"type": "number",
"description": "Depletion rate per pay period.",
"format": "double"
},
"periodMaxAccrue": {
"type": "number",
"description": "Maximum amount that can be accrued per pay period. Leave null if there is no maximum amount.",
"format": "double",
"nullable": true
},
"calendarYearMaxAccrue": {
"type": "number",
"description": "Maximum amount that can be accrued per calendar year. Leave null if there is no maximum amount.",
"format": "double",
"nullable": true
},
"periodMaxBalance": {
"type": "number",
"description": "Maximum accrual balance that can be carried over after a pay period. Leave null if there is no maximum amount.",
"format": "double",
"nullable": true
},
"calendarYearMaxBalance": {
"type": "number",
"description": "Maximum accrual balance that can be carried over after a calendar year. Leave null if there is no maximum amount.",
"format": "double",
"nullable": true
},
"anniversaryMaxBalance": {
"type": "number",
"description": "Maximum accrual balance that can be carried over after the employee's anniversary date. Leave null if there is no maximum amount.",
"format": "double",
"nullable": true
},
"effectiveDate": {
"type": "string",
"description": "Date when the tier takes effect.",
"format": "date-time"
},
"tierActive": {
"type": "boolean",
"description": "Indicates if the accrual tier is active."
}
},
"additionalProperties": false,
"description": "A request to update Accrual Tiers for an Employee."
},
"TwApi.Services.Employees.API.Models.UpdateEmployeeAddressRequest": {
"type": "object",
"properties": {
"bypassAddressValidationService": {
"type": "boolean",
"description": "If true, bypasses validating that address against the United State Postal Service database."
},
"street1": {
"maxLength": 50,
"type": "string",
"description": "This is the main street address. I.E. 1234 Main St.",
"nullable": true
},
"street2": {
"maxLength": 50,
"type": "string",
"description": "This is the secondary part of the address reserved for things such as identifying suite or apartment numbers.",
"nullable": true
},
"municipality": {
"maxLength": 50,
"type": "string",
"description": "The city/municipality of the address.",
"nullable": true
},
"region": {
"maxLength": 5,
"type": "string",
"description": "The state/region of the address.",
"nullable": true
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"type": "string",
"description": "The postal code of the address.",
"nullable": true
},
"municipalityId": {
"type": "integer",
"description": "Maps back to CityCode in the database. A list of values can be found at the datalists/localTaxes endpoint.",
"format": "int32",
"nullable": true
},
"schoolDistrictId": {
"type": "integer",
"description": "Maps back to SchoolDistrictCode in the database. A list of values can be found at the datalists/localTaxes endpoint.",
"format": "int32",
"nullable": true
},
"schoolJurisId": {
"type": "integer",
"description": "The employee's school juris id.",
"format": "int32",
"nullable": true
},
"psdCode": {
"maxLength": 10,
"minLength": 0,
"type": "string",
"description": "The PSDCode. Used for addresses in Pennsylvania.",
"nullable": true
},
"countyId": {
"type": "integer",
"description": "Maps back to CountyCode in the database. A list of values can be found at the datalists/localTaxes endpoint.",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to update an employee's main address."
},
"TwApi.Services.Employees.API.Models.UpdateEmployeeAdjustmentRequest": {
"required": [
"dateServed",
"deductGreatestRuleCase",
"frequencyId"
],
"type": "object",
"properties": {
"isActive": {
"type": "boolean",
"description": "Used to indicate whether or not the adjustment should be collected during payroll. An inactive adjustment will not be collected while\r\nan active adjustment will try to collect if possible."
},
"sequence": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"description": "Optional - specify a sequence for this adjustment. Adjustments with no sequence are calculated simultaneously, then adjustments with a\r\nsequence are calculated in ascending order (sequence 1, then sequence 2, etc).",
"format": "int32",
"nullable": true
},
"description": {
"maxLength": 100,
"minLength": 0,
"type": "string",
"description": "A description of the adjustment.",
"nullable": true
},
"frequencyId": {
"type": "string",
"description": "Frequency with which the adjustment should be applied. Influences adjustment calculation during payroll - adjustments will actually be\r\napplied on each check. Valid frequencies can be found in the Adjustment Frequencies datalist.",
"format": "uuid"
},
"dateServed": {
"type": "string",
"description": "Use to record when a garnishment, child support, or similar order was served.\r\nThe date format is ISO 8601 YYYY-MM-DD.",
"format": "date-time"
},
"startDate": {
"type": "string",
"description": "If specified, the adjustment will not deduct on checks processed prior to this date.\r\nThe date format is ISO 8601 YYYY-MM-DD.",
"format": "date-time",
"nullable": true
},
"endDate": {
"type": "string",
"description": "If specified, the adjustment will not deduct on checks processed after this date.\r\nThe date format is ISO 8601 YYYY-MM-DD.",
"format": "date-time",
"nullable": true
},
"authorityId": {
"type": "integer",
"description": "Authority ordering the adjustment. Valid authorities can be found in the Adjustment Authorities datalist.",
"format": "int32",
"nullable": true
},
"caseNumber": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "The case number for the adjustment if any.",
"nullable": true
},
"note": {
"maxLength": 1000,
"minLength": 0,
"type": "string",
"description": "A note field.",
"nullable": true
},
"maximumLifetimeTakeAmount": {
"minimum": 0,
"type": "number",
"description": "The maximum amount that can ever be collected for the adjustment.",
"format": "double",
"nullable": true
},
"maximumYearlyTakeAmount": {
"minimum": 0,
"type": "number",
"description": "The maximum amount that can be collected every calendar year for the adjustment.",
"format": "double",
"nullable": true
},
"maximumMonthlyTakeAmount": {
"minimum": 0,
"type": "number",
"description": "The maximum amount that can be collected every month for the adjustment.",
"format": "double",
"nullable": true
},
"maximumPerPeriodTakeAmount": {
"minimum": 0,
"type": "number",
"description": "The maximum amount that can be collected every pay period for the adjustment.",
"format": "double",
"nullable": true
},
"minimumRemainingAfterCalculation": {
"minimum": 0,
"type": "number",
"description": "If specified, the adjustment will not reduce the net of a paycheck below the specified amount.",
"format": "double",
"nullable": true
},
"routingNumber": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Bank Routing Number - Use for secondary direct deposit adjustments. Valid Routing Numbers can be found in the Routing Numbers Datalist.",
"nullable": true
},
"accountNumber": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Bank Account Number - Use for secondary direct deposit adjustments.",
"nullable": true
},
"accountTypeId": {
"maxLength": 3,
"minLength": 0,
"type": "string",
"description": "Use for secondary direct deposit adjustments to indicate what kind of account this is. Valid Electronic Pay Account Types can be found in\r\nthe Electronic Pay Account Types Datalist.",
"nullable": true
},
"datePreNoteSent": {
"type": "string",
"description": "DatePreNoteSent cannot be after DatePreNoteApproved or DatePreNoteDisapproved.",
"format": "date-time",
"nullable": true
},
"datePreNoteApproved": {
"type": "string",
"description": "If DatePreNoteApproved is specified, DatePreNoteDisapproved must not be specified.",
"format": "date-time",
"nullable": true
},
"datePreNoteDisapproved": {
"type": "string",
"description": "If DatePreNoteDisapproved is specified, DatePreNoteApproved must not be specified.",
"format": "date-time",
"nullable": true
},
"misc1": {
"maxLength": 25,
"minLength": 0,
"type": "string",
"description": "A field for miscellaneous data.",
"nullable": true
},
"misc2": {
"maxLength": 25,
"minLength": 0,
"type": "string",
"description": "A field for miscellaneous data.",
"nullable": true
},
"misc3": {
"maxLength": 25,
"minLength": 0,
"type": "string",
"description": "A field for miscellaneous data.",
"nullable": true
},
"monthlyPayCycleId": {
"type": "integer",
"description": "A field for do indicate which week the adjustment should be taken out of an employee's paycheck if collected monthly. A list of values\r\ncan be found at the datalists/monthlyPayCycles endpoint.",
"format": "int32",
"nullable": true
},
"deductGreatestRuleCase": {
"type": "boolean",
"description": "If true and this adjustment has multiple rule cases, payroll calculations will use the rule case that results in the highest deduction."
},
"levyDependents": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "The number of dependents to account for when calculating the amount of a levy adjustment. If the adjustment is a levy, this field is required, otherwise it must be null or 0.",
"format": "int32"
},
"ruleCases": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeAdjustmentRuleCaseRequest"
},
"description": "A collection of one or more rules that define how much an adjustment should deduct under various circumstances.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to update an existing Adjustment for an Employee."
},
"TwApi.Services.Employees.API.Models.UpdateEmployeeAdjustmentRuleCaseRequest": {
"required": [
"takeValue"
],
"type": "object",
"properties": {
"ruleCaseId": {
"type": "string",
"description": "The Id of the Rule Case. A list of rule cases can be found at the employees/{employeeId}/adjustments/{employeeAdjustmentId} endpoint.",
"format": "uuid",
"nullable": true
},
"ruleColumnId": {
"type": "string",
"description": "Works with RuleConstraintTypeId and RuleComparisonValue to determine whether the adjustment should use this rule. Defines what type of\r\npay the constraint should compare to (ex gross or net). Valid rule columns can be found in the Adjustment Rule Case Columns datalist.",
"format": "uuid",
"nullable": true
},
"ruleConstraintTypeId": {
"type": "string",
"description": "Works with RuleColumnId and RuleComparisonValue to determine whether the adjustment should use this rule. Defines a constraint type to\r\ncompare with (ex less than, greater than). Valid rule constraint types can be found in the Adjustment Rule Case Constraint Types datalist.",
"format": "uuid",
"nullable": true
},
"ruleComparisonValue": {
"type": "number",
"description": "Works with RuleColumnId and RuleConstraintTypeId to determine whether the adjustment should use this rule. Ex calculate only if gross\r\nis greater than 200.",
"format": "double",
"nullable": true
},
"takeValueAsPercentOfColumnId": {
"type": "string",
"description": "If specified, the adjustment will deduct the TakeValue as a percentage of a type of pay (ex 50% of gross pay). Valid rule columns can\r\nbe found in the Adjustment Rule Case Columns datalist.",
"format": "uuid",
"nullable": true
},
"takeValue": {
"type": "number",
"description": "How much the adjustment should deduct.",
"format": "double"
},
"takeMaximumValue": {
"type": "number",
"description": "If specified, adjustment will deduct no more than this amount.",
"format": "double",
"nullable": true
},
"takeMaximumValueAsPercentOfColumnId": {
"type": "string",
"description": "If specified, the adjustment will deduct no more than TakeMaximumValue as a percentage of a type of pay (ex no more than 50% of gross).\r\nValid rule columns can be found in the Adjustment Rule Case Columns datalist.",
"format": "uuid",
"nullable": true
},
"takeAllOrNothing": {
"type": "boolean",
"description": "If true, the adjustment will only deduct if the entire TakeValue can be deducted."
}
},
"additionalProperties": false,
"description": "A request to update a Rule Case for an Adjustment on an Employee."
},
"TwApi.Services.Employees.API.Models.UpdateEmployeeDriversLicenseRequest": {
"required": [
"number",
"region"
],
"type": "object",
"properties": {
"region": {
"maxLength": 5,
"minLength": 0,
"type": "string",
"description": "Region of the Drivers License. Valid regions can be found in the Regions datalist."
},
"number": {
"maxLength": 20,
"minLength": 0,
"type": "string",
"description": "The drivers license number."
},
"class": {
"maxLength": 10,
"minLength": 0,
"type": "string",
"description": "The drivers license class.",
"nullable": true
},
"expirationDate": {
"type": "string",
"description": "Expiration date of the license.",
"format": "date-time",
"nullable": true
},
"noExpirationDateProvided": {
"type": "boolean",
"description": "If true, signifies that no expiration date was provided on the license."
}
},
"additionalProperties": false,
"description": "A request to update a Driver's License for an Employee."
},
"TwApi.Services.Employees.API.Models.UpdateEmployeeEducationRequest": {
"type": "object",
"properties": {
"bypassAddressValidationService": {
"type": "boolean",
"description": "If true, bypasses validating that the address against the United State Postal Service database."
},
"includeInBackgroundChecks": {
"type": "boolean",
"description": "If true, the education item will be included when performing background checks that utilize education details."
},
"institutionAttended": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "The name of the educational institution attended.",
"nullable": true
},
"degreeAwarded": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "The type of degree or program attended",
"nullable": true
},
"enrollmentStatus": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "The enrollment or completion status",
"nullable": true
},
"other": {
"type": "string",
"description": "A field for notes or other comments.",
"nullable": true
},
"grade": {
"type": "number",
"description": "Maps back to GPA on employeeeducation.",
"format": "double",
"nullable": true
},
"dateAttendedStart": {
"type": "string",
"description": "Maps back to DatesAttendedStart on employeeeducation.\r\nThe date format is ISO 8601 YYYY-MM-DD.",
"format": "date-time",
"nullable": true
},
"dateAttendedEnd": {
"type": "string",
"description": "Maps back to DatesAttendedEnd on employeeeducation.\r\nThe recommended date Format is ISO 8601 YYYY-MM-DD.",
"format": "date-time",
"nullable": true
},
"degreeDate": {
"type": "string",
"description": "The date the degree was awarded if any.\r\nThe recommended date Format is ISO 8601 YYYY-MM-DD.",
"format": "date-time",
"nullable": true
},
"major": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "The major/focus of the education.",
"nullable": true
},
"contactInformation": {
"maxLength": 1000,
"minLength": 0,
"type": "string",
"description": "Contact information for the institution.",
"nullable": true
},
"street1": {
"maxLength": 255,
"type": "string",
"description": "This is the main street address. I.E. 1234 Main St.",
"nullable": true
},
"street2": {
"maxLength": 255,
"type": "string",
"description": "This is the secondary part of the address reserved for things such as identifying suite or apartment numbers.",
"nullable": true
},
"municipality": {
"maxLength": 255,
"type": "string",
"description": "The city/municipality of the address.",
"nullable": true
},
"region": {
"maxLength": 5,
"type": "string",
"description": "The state/region of the address.",
"nullable": true
},
"postalCode": {
"maxLength": 255,
"type": "string",
"description": "The postal code of the address.",
"nullable": true
},
"countryCode": {
"type": "integer",
"description": "The Id of the country. Valid countries can be found in the Countries datalist.",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to update an Education record on an Employee."
},
"TwApi.Services.Employees.API.Models.UpdateEmployeeGovernmentPersonalIdentifierRequest": {
"required": [
"countryCode"
],
"type": "object",
"properties": {
"countryCode": {
"type": "integer",
"description": "The country this ID is for. Valid countries can be found in the Countries datalist.",
"format": "int32"
},
"governmentPersonalId": {
"type": "string",
"description": "The government personal identifier for the employee. This value would an SSN when the countrycode is 840 (US), NI No for 826 (UK), and SIN for 124 (Canada).",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to update a Government Personal Identifier for an Employee."
},
"TwApi.Services.Employees.API.Models.UpdateEmployeeInterestCodeRequest": {
"required": [
"interestCodeId",
"isValidated"
],
"type": "object",
"properties": {
"interestCodeId": {
"type": "integer",
"description": "Id for the new interest code. Valid Interest Code Ids can be found in the Interest Codes Datalist.",
"format": "int32"
},
"years": {
"type": "number",
"description": "How long the employee has had this skill.",
"format": "double",
"nullable": true
},
"note": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "A field for notes.",
"nullable": true
},
"isValidated": {
"type": "boolean",
"description": "Indicates whether or not the interest code has been verified. This may be used in the cases where employees self report skills with\r\nexperience."
}
},
"additionalProperties": false,
"description": "A request to an existing Interest Code on an Employee"
},
"TwApi.Services.Employees.API.Models.UpdateEmployeeInterestCodesRequest": {
"required": [
"interestCodes"
],
"type": "object",
"properties": {
"interestCodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.InterestCodes.Models.EmployeeInterestCode"
},
"description": "The employee's updated interest codes"
}
},
"additionalProperties": false,
"description": "A request to update an Employee's interest codes"
},
"TwApi.Services.Employees.API.Models.UpdateEmployeeLanguageRequest": {
"required": [
"languageCode"
],
"type": "object",
"properties": {
"languageCode": {
"minLength": 1,
"type": "string",
"description": "Language code preferred by the employee. Ex: \"en-us\"."
}
},
"additionalProperties": false,
"description": "A request to update the employee's preferred language."
},
"TwApi.Services.Employees.API.Models.UpdateEmployeeReferenceQuestionsRequest": {
"required": [
"answers"
],
"type": "object",
"properties": {
"answers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.UpdateEmployeeReferenceQuestionsRequest.Answer"
},
"description": "A list of answers to the questions."
}
},
"additionalProperties": false,
"description": "A request to update Questions asked of a Reference about an Employee."
},
"TwApi.Services.Employees.API.Models.UpdateEmployeeReferenceQuestionsRequest.Answer": {
"required": [
"questionId"
],
"type": "object",
"properties": {
"questionId": {
"type": "integer",
"description": "The Id of the question. A list of questions can be found at the employees/{employeeId}/references/{referenceId}/questions\r\nendpoint.",
"format": "int64"
},
"answerText": {
"maxLength": 3000,
"minLength": 0,
"type": "string",
"description": "The reference's answer to the question.",
"nullable": true
}
},
"additionalProperties": false,
"description": "An answer to a question."
},
"TwApi.Services.Employees.API.Models.UpdateEmployeeReferenceRequest": {
"required": [
"bypassAddressValidationService"
],
"type": "object",
"properties": {
"name": {
"maxLength": 100,
"minLength": 0,
"type": "string",
"description": "The name of the person serving as a reference.\r\nDEPRECATED - Use FirstName and LastName instead.",
"nullable": true
},
"phoneNumber": {
"maxLength": 256,
"minLength": 0,
"type": "string",
"description": "A phone number to contact the reference.",
"nullable": true
},
"phoneNumberCountryCallingCode": {
"type": "integer",
"description": "Country Calling Code for phone number. Valid Country Calling Codes can be found in the Country Calling Codes Datalist.",
"format": "int32",
"nullable": true
},
"email": {
"maxLength": 256,
"minLength": 0,
"type": "string",
"description": "An email address to contact the reference.",
"nullable": true
},
"relationship": {
"maxLength": 256,
"minLength": 0,
"type": "string",
"description": "The relationship between the reference and the employee.",
"nullable": true
},
"companyName": {
"maxLength": 200,
"minLength": 0,
"type": "string",
"description": "The name of the company the reference belongs to.",
"nullable": true
},
"dateReferenceChecked": {
"type": "string",
"description": "The date the referenced was checked.\r\nThe date format is ISO 8601 YYYY-MM-DD.",
"format": "date-time",
"nullable": true
},
"dateReferenceSent": {
"type": "string",
"description": "The date a request for reference was sent.\r\nThe date format is ISO 8601 YYYY-MM-DD.",
"format": "date-time",
"nullable": true
},
"workHistoryId": {
"type": "integer",
"description": "The work history item to link the reference to. Valid values can be found at /employees/{id}/WorkHistory",
"format": "int32",
"nullable": true
},
"isOkayToContact": {
"type": "boolean",
"description": "Is it okay to contact this reference?"
},
"includeInBackgroundChecks": {
"type": "boolean",
"description": "Should this reference be included in background checks?"
},
"firstName": {
"maxLength": 50,
"type": "string",
"description": "The first name of the person serving as a reference.",
"nullable": true
},
"lastName": {
"maxLength": 50,
"type": "string",
"description": "The last name of the person serving as a reference.",
"nullable": true
},
"referenceType": {
"maxLength": 50,
"type": "string",
"description": "The type of reference i.e. Personal, Professional",
"nullable": true
},
"street1": {
"maxLength": 255,
"type": "string",
"description": "This is the main street address. I.E. 1234 Main St.",
"nullable": true
},
"street2": {
"maxLength": 255,
"type": "string",
"description": "This is the secondary part of the address reserved for things such as identifying suite or apartment numbers.",
"nullable": true
},
"municipality": {
"maxLength": 255,
"type": "string",
"description": "The city/municipality of the address.",
"nullable": true
},
"region": {
"maxLength": 5,
"type": "string",
"description": "The state/region of the address.",
"nullable": true
},
"postalCode": {
"maxLength": 255,
"type": "string",
"description": "The postal code of the address.",
"nullable": true
},
"countryCode": {
"type": "integer",
"description": "Previous employer's country code - A list of valid country codes can be found in the Country Codes datalist.",
"format": "int32",
"nullable": true
},
"bypassAddressValidationService": {
"type": "boolean",
"description": "If true, address validation will be bypassed and the address will save as long as all other validation passes."
},
"notes": {
"maxLength": 2500,
"minLength": 0,
"type": "string",
"description": "The reference Notes.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to update a Reference record for an Employee."
},
"TwApi.Services.Employees.API.Models.UpdateEmployeeRequiredDocumentRequest": {
"required": [
"active",
"required",
"requiredDocumentAuthorityId",
"requiredDocumentTypeId"
],
"type": "object",
"properties": {
"requiredDocumentTypeId": {
"type": "integer",
"description": "Int type id for required document.",
"format": "int32"
},
"notes": {
"type": "string",
"description": "String notes for required document.",
"nullable": true
},
"expirationDate": {
"type": "string",
"description": "DateTime date when required document expires.",
"format": "date-time",
"nullable": true
},
"issuedDate": {
"type": "string",
"description": "DateTime date when the required document was issued.",
"format": "date-time",
"nullable": true
},
"requestedDate": {
"type": "string",
"description": "DateTime date when the required document was requested.",
"format": "date-time",
"nullable": true
},
"receivedDate": {
"type": "string",
"description": "DateTime date when the required document was received.",
"format": "date-time",
"nullable": true
},
"licenseNumber": {
"type": "string",
"description": "String license number of the required document.",
"nullable": true
},
"required": {
"type": "boolean",
"description": "Bool whether the document is required."
},
"active": {
"type": "boolean",
"description": "Bool whether the document is active."
},
"requiredDocumentAuthorityId": {
"type": "integer",
"description": "Int Id of the required document authority.",
"format": "int32"
},
"requiredDocumentStatusId": {
"type": "string",
"description": "Guid Id of the required document status.",
"format": "uuid",
"nullable": true
},
"documentId": {
"type": "integer",
"description": "The document identifier linked with this required document.",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to update the RequiredDocument."
},
"TwApi.Services.Employees.API.Models.UpdateEmployeeTaxRequest": {
"required": [
"additionalAllowances",
"additionalWithholdingAmount",
"allowances",
"isExempt",
"taxAmount",
"taxJurisdictionId",
"taxPercentage"
],
"type": "object",
"properties": {
"taxJurisdictionId": {
"type": "integer",
"description": "The employee tax jurisdiction Id.",
"format": "int32"
},
"taxAmount": {
"maximum": 1000000000,
"minimum": -1000000000,
"type": "number",
"description": "The employee tax amount.",
"format": "double"
},
"taxPercentage": {
"maximum": 1,
"minimum": 0,
"type": "number",
"description": "The employee tax percentage.",
"format": "double"
},
"allowances": {
"maximum": 255,
"minimum": 0,
"type": "integer",
"description": "The employee tax allowances.",
"format": "int32"
},
"isExempt": {
"type": "boolean",
"description": "A flag specifying whether or not the employee tax is exempt."
},
"employerId": {
"type": "integer",
"description": "The employee tax employer Id.",
"format": "int32",
"nullable": true
},
"additionalAllowances": {
"maximum": 255,
"minimum": 0,
"type": "integer",
"description": "The employee tax additional allowances.",
"format": "int32"
},
"additionalWithholdingAmount": {
"maximum": 1000000000,
"minimum": -1000000000,
"type": "number",
"description": "The employee tax additional withholding amount.",
"format": "double"
},
"alternativeStandardDeduction": {
"maximum": 1000000000,
"minimum": 0.01,
"type": "number",
"description": "Alternative standard deduction. Allowed only for TaxJurisdictions with TwApi.Shared.Commands.Datalists.TaxJurisdictionListQuery.Result.UsesAlternativeStandardDeduction=true",
"format": "double",
"nullable": true
},
"dependents": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "The number of dependants the employee claims.",
"format": "int32"
}
},
"additionalProperties": false,
"description": "A request model to update a tax for an employee."
},
"TwApi.Services.Employees.API.Models.UpdateEmployeeTemporaryMailingAddressRequest": {
"type": "object",
"properties": {
"isTemporaryMailingAddressActive": {
"type": "boolean",
"description": "If true, bypasses validating that address against the United State Postal Service database."
},
"bypassAddressValidationService": {
"type": "boolean",
"description": "If true, address validation will be bypassed and the address will save as long as all other validation passes."
},
"street1": {
"maxLength": 50,
"type": "string",
"description": "This is the main street address. I.E. 1234 Main St.",
"nullable": true
},
"street2": {
"maxLength": 50,
"type": "string",
"description": "This is the secondary part of the address reserved for things such as identifying suite or apartment numbers.",
"nullable": true
},
"municipality": {
"maxLength": 50,
"type": "string",
"description": "The city/municipality of the address.",
"nullable": true
},
"region": {
"maxLength": 5,
"type": "string",
"description": "The state/region of the address.",
"nullable": true
},
"postalCode": {
"maxLength": 10,
"type": "string",
"description": "The postal code of the address.",
"nullable": true
},
"countryCode": {
"type": "integer",
"description": "The country code identifying what country the address is in. A list of country codes can be found at the\r\ndatalists/countries endpoint.",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to update an employee's temporary mailing address."
},
"TwApi.Services.Employees.API.Models.UpdateEmployeeWorkHistoryRequest": {
"required": [
"bypassAddressValidationService",
"includeInBackgroundChecks",
"isFullTime",
"isOkayToContact",
"isPartTime",
"isTemporaryJob"
],
"type": "object",
"properties": {
"startDate": {
"type": "string",
"description": "The date the employee started the job.\r\nThe date format is ISO 8601 YYYY-MM-DD.",
"format": "date-time",
"nullable": true
},
"endDate": {
"type": "string",
"description": "The date the employee ended the job.\r\nThe date format is ISO 8601 YYYY-MM-DD.",
"format": "date-time",
"nullable": true
},
"employer": {
"maxLength": 50,
"type": "string",
"description": "The employer the employee worked for.",
"nullable": true
},
"street1": {
"maxLength": 255,
"type": "string",
"description": "This is the main street address. I.E. 1234 Main St.",
"nullable": true
},
"street2": {
"maxLength": 255,
"type": "string",
"description": "This is the secondary part of the address reserved for things such as identifying suite or apartment numbers.",
"nullable": true
},
"municipality": {
"maxLength": 255,
"type": "string",
"description": "The city/municipality of the address.",
"nullable": true
},
"region": {
"maxLength": 5,
"type": "string",
"description": "The state/region of the address.",
"nullable": true
},
"postalCode": {
"maxLength": 255,
"type": "string",
"description": "The postal code of the address.",
"nullable": true
},
"countryCode": {
"type": "integer",
"description": "Previous employer's country code - A list of valid country codes can be found in the Country Codes datalist.",
"format": "int32",
"nullable": true
},
"phoneNumber": {
"maxLength": 255,
"type": "string",
"description": "Maps to Phone in the database.",
"nullable": true
},
"phoneNumberCountryCallingCode": {
"type": "integer",
"description": "Previous employer's country calling code - A list of valid country calling codes can be found in the Country Calling Codes datalist.",
"format": "int32",
"nullable": true
},
"position": {
"maxLength": 50,
"type": "string",
"description": "Maps to Pos in the database.",
"nullable": true
},
"pay": {
"maxLength": 50,
"type": "string",
"description": "The amount the employee was paid.",
"nullable": true
},
"isFullTime": {
"type": "boolean",
"description": "Maps to FT in the database."
},
"isPartTime": {
"type": "boolean",
"description": "Maps to PT in the database."
},
"isTemporaryJob": {
"type": "boolean",
"description": "Maps to TempJob in the database."
},
"duties": {
"maxLength": 1000,
"type": "string",
"description": "The duties the employee was expected to perform.",
"nullable": true
},
"supervisor": {
"maxLength": 50,
"type": "string",
"description": "The name of the employee's supervisor at the job.\r\nDEPRECATED - use SupervisorFirstName and SupervisorLastName fields instead.",
"nullable": true
},
"reasonForLeaving": {
"maxLength": 1000,
"type": "string",
"description": "Maps to Reason in the database.",
"nullable": true
},
"isOkayToContact": {
"type": "boolean",
"description": "If true, it is okay to contact this employer."
},
"includeInBackgroundChecks": {
"type": "boolean",
"description": "If true, this job will be included in background checks on the employee."
},
"supervisorFirstName": {
"maxLength": 255,
"type": "string",
"description": "The first name of the employee's supervisor at the job.",
"nullable": true
},
"supervisorLastName": {
"maxLength": 255,
"type": "string",
"description": "The last name of the employee's supervisor at the job.",
"nullable": true
},
"supervisorTitle": {
"maxLength": 255,
"type": "string",
"description": "The title of the employee's supervisor at the job.",
"nullable": true
},
"supervisorEmail": {
"maxLength": 255,
"type": "string",
"description": "The email address of the employee's supervisor at the job.",
"nullable": true
},
"bypassAddressValidationService": {
"type": "boolean",
"description": "If true, address validation will be bypassed and the address will save as long as all other validation passes."
}
},
"additionalProperties": false,
"description": "A request to update an Employee's Work History record."
},
"TwApi.Services.Employees.API.Models.UpdateEmployeeWorkInterestsRequest": {
"required": [
"isAvailableOnFriday",
"isAvailableOnMonday",
"isAvailableOnSaturday",
"isAvailableOnSunday",
"isAvailableOnThursday",
"isAvailableOnTuesday",
"isAvailableOnWednesday"
],
"type": "object",
"properties": {
"preferredLocation": {
"maxLength": 100,
"minLength": 0,
"type": "string",
"description": "The preferred work location.",
"nullable": true
},
"hourlySalaryRequirement": {
"maximum": 49999999.99,
"minimum": 0,
"type": "number",
"description": "The desired Employee pay.",
"format": "double",
"nullable": true
},
"availability": {
"maxLength": 100,
"minLength": 0,
"type": "string",
"description": "A value describing when the Employee is available for work.",
"nullable": true
},
"isAvailableOnMonday": {
"type": "boolean",
"description": "A value indicating whether the Employee is available on Monday."
},
"isAvailableOnTuesday": {
"type": "boolean",
"description": "A value indicating whether the Employee is available on Tuesday."
},
"isAvailableOnWednesday": {
"type": "boolean",
"description": "A value indicating whether the Employee is available on Wednesday."
},
"isAvailableOnThursday": {
"type": "boolean",
"description": "A value indicating whether the Employee is available on Thursday."
},
"isAvailableOnFriday": {
"type": "boolean",
"description": "A value indicating whether the Employee is available on Friday."
},
"isAvailableOnSaturday": {
"type": "boolean",
"description": "A value indicating whether the Employee is available on Saturday."
},
"isAvailableOnSunday": {
"type": "boolean",
"description": "A value indicating whether the Employee is available on Sunday."
}
},
"additionalProperties": false,
"description": "A Request model for updating the Employee's Work Interests."
},
"TwApi.Services.Employees.API.Models.UpdateInterviewQuestionsRequest": {
"type": "object",
"properties": {
"markComplete": {
"type": "boolean",
"description": "Bool to mark interview as complete."
},
"answers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.AnswerPair"
},
"description": "List of answer and question id pairs.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to update the answers and ."
},
"TwApi.Services.Employees.API.Models.UpdateInterviewRequest": {
"required": [
"answers",
"interviewName"
],
"type": "object",
"properties": {
"interviewName": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "The interview name."
},
"answers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Employees.API.Models.AnswerPair"
},
"description": "List of answer and question id pairs."
}
},
"additionalProperties": false,
"description": "A request to update the interview."
},
"TwApi.Services.Employees.API.Models.UpdatePayTransparencyRequest": {
"type": "object",
"properties": {
"payTransparencyRaceId": {
"type": "integer",
"description": "Id of Employee's race",
"format": "int32",
"nullable": true
},
"racePayTransparencyCollectionTypeId": {
"type": "integer",
"description": "How the race of the employee was collected.",
"format": "int32",
"nullable": true
},
"racePayTransparencyCollectionTypeBasisId": {
"type": "integer",
"description": "What the race of the employee is determined from (applies if collection method requires a basis to judge from)",
"format": "int32",
"nullable": true
},
"payTransparencyGenderId": {
"type": "integer",
"description": "Id of Employee's gender",
"format": "int32",
"nullable": true
},
"genderPayTransparencyCollectionTypeId": {
"type": "integer",
"description": "How the gender of the employee was collected.",
"format": "int32",
"nullable": true
},
"genderPayTransparencyCollectionTypeBasisId": {
"type": "integer",
"description": "What the gender of the employee is determined from (applies if collection method requires a basis to judge from)",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to update a PayTransparency record for an Employee."
},
"TwApi.Services.Employees.API.Models.UpdateUserNotificationSubscriptionRequest": {
"required": [
"isSubscribed"
],
"type": "object",
"properties": {
"isSubscribed": {
"type": "boolean",
"description": "This value is used to specify whether the user should receive notifications."
}
},
"additionalProperties": false,
"description": "A request to update a user's subscription preference for a given notification type/category/method"
},
"TwApi.Services.Employees.Service.Commands.Accruals.CreateEmployeeAccrualCommand.Result": {
"type": "object",
"properties": {
"employeeAccrualId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.Accruals.EmployeeAccrualBalanceList.Result": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"lifetimeAccrued": {
"type": "number",
"format": "double"
},
"lifetimeDepleted": {
"type": "number",
"format": "double"
},
"totalAccruedBalance": {
"type": "number",
"format": "double"
},
"eligibleBalance": {
"type": "number",
"format": "double"
},
"eligibilityDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"eligibleBalanceDelayDays": {
"type": "integer",
"format": "int32"
},
"availableBalance": {
"type": "number",
"format": "double"
},
"annualDepletionRolloverDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"annualDepletionLimit": {
"type": "integer",
"format": "int32"
},
"employeeAccrualId": {
"type": "string",
"format": "uuid"
},
"accrualId": {
"type": "string",
"format": "uuid"
},
"lastWeekendDateAccrued": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.Accruals.EmployeeAccrualHistoryList.Result": {
"type": "object",
"properties": {
"employeeId": {
"type": "integer",
"format": "int64"
},
"employeeAccrualItemId": {
"type": "string",
"format": "uuid"
},
"accrualId": {
"type": "string",
"format": "uuid"
},
"accrualName": {
"type": "string",
"nullable": true
},
"accrualTierId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"accrualTier": {
"type": "string",
"nullable": true
},
"accrualItemType": {
"type": "string",
"nullable": true
},
"amount": {
"type": "number",
"format": "double"
},
"notes": {
"type": "string",
"nullable": true
},
"checkId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"isAccrue": {
"type": "boolean"
},
"isDeplete": {
"type": "boolean"
},
"isManualAdjustment": {
"type": "boolean"
},
"weekendDate": {
"type": "string",
"format": "date-time"
},
"dateCreated": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.Accruals.EmployeeAccrualsList.AccrualTier": {
"type": "object",
"properties": {
"employeeAccrualTierId": {
"type": "string",
"format": "uuid"
},
"tierDescription": {
"type": "string",
"nullable": true
},
"tierActive": {
"type": "boolean"
},
"tierCreatedByServiceRepId": {
"type": "integer",
"format": "int64"
},
"tierCreatedByServiceRepName": {
"type": "string",
"nullable": true
},
"effectiveDate": {
"type": "string",
"format": "date-time"
},
"accrualRate": {
"type": "number",
"format": "double"
},
"depletionRate": {
"type": "number",
"format": "double"
},
"periodMaxAccrue": {
"type": "number",
"format": "double",
"nullable": true
},
"periodMaxBalance": {
"type": "number",
"format": "double",
"nullable": true
},
"calendarYearMaxBalance": {
"type": "number",
"format": "double",
"nullable": true
},
"calendarYearMaxAccrue": {
"type": "number",
"format": "double",
"nullable": true
},
"anniversaryMaxBalance": {
"type": "number",
"format": "double",
"nullable": true
},
"accrualTierId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.Accruals.EmployeeAccrualsList.Result": {
"type": "object",
"properties": {
"accrualTiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.Accruals.EmployeeAccrualsList.AccrualTier"
},
"nullable": true
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"employeeAccrualId": {
"type": "string",
"format": "uuid"
},
"accrualId": {
"type": "string",
"format": "uuid"
},
"isActive": {
"type": "boolean",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"createdByServiceRepId": {
"type": "integer",
"format": "int32"
},
"createdByServiceRepName": {
"type": "string",
"nullable": true
},
"accrueOnDT": {
"type": "boolean"
},
"accrueOnOT": {
"type": "boolean"
},
"allowNegativeBalance": {
"type": "boolean"
},
"applyOnlyWhenAssignmentHasMatchingAccrual": {
"type": "boolean"
},
"applyOnlyWhenCustomerHasMatchingAccrual": {
"type": "boolean"
},
"annualDepletionRolloverDate": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.Accruals.InsertManualEmployeeAccrual.Result": {
"type": "object",
"properties": {
"employeeAccrualItemId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.Accruals.PreviewManualEmployeeAccrual.Result": {
"type": "object",
"properties": {
"originalTotalBalance": {
"type": "number",
"format": "double"
},
"newTotalBalance": {
"type": "number",
"format": "double"
},
"originalEligibleBalance": {
"type": "number",
"format": "double"
},
"newEligibleBalance": {
"type": "number",
"format": "double"
},
"originalAvailableBalance": {
"type": "number",
"format": "double"
},
"newAvailableBalance": {
"type": "number",
"format": "double"
},
"originalCalendarYearMaxAccrueAmountRemaining": {
"type": "number",
"format": "double",
"nullable": true
},
"newCalendarYearMaxAccrueAmountRemaining": {
"type": "number",
"format": "double",
"nullable": true
},
"originalPeriodMaxAccrueAmountRemaining": {
"type": "number",
"format": "double",
"nullable": true
},
"newPeriodMaxAccrueAmountRemaining": {
"type": "number",
"format": "double",
"nullable": true
},
"originalAnnualDepletionLimitAmountRemaining": {
"type": "number",
"format": "double",
"nullable": true
},
"newAnnualDepletionLimitAmountRemaining": {
"type": "number",
"format": "double",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.Adjustments.CreateEmployeeAdjustmentCommand.Result": {
"type": "object",
"properties": {
"employeeAdjustmentId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.Adjustments.EmployeeAdjustmentDetailsQuery.Result": {
"type": "object",
"properties": {
"employeeAdjustmentId": {
"type": "integer",
"format": "int32"
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"adjustmentId": {
"type": "integer",
"format": "int32"
},
"adjustment": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"employerId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"employer": {
"type": "string",
"nullable": true
},
"sequence": {
"type": "integer",
"format": "int32",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"canBeDeleted": {
"type": "boolean"
},
"frequencyId": {
"type": "string",
"format": "uuid"
},
"frequency": {
"type": "string",
"nullable": true
},
"startDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"endDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"authorityId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"authority": {
"type": "string",
"nullable": true
},
"caseNumber": {
"type": "string",
"nullable": true
},
"note": {
"type": "string",
"nullable": true
},
"dateServed": {
"type": "string",
"format": "date-time"
},
"maximumLifetimeTakeAmount": {
"type": "number",
"format": "double"
},
"maximumYearlyTakeAmount": {
"type": "number",
"format": "double"
},
"maximumMonthlyTakeAmount": {
"type": "number",
"format": "double"
},
"maximumPerPeriodTakeAmount": {
"type": "number",
"format": "double"
},
"minimumRemainingAfterCalculation": {
"type": "number",
"format": "double",
"nullable": true
},
"routingNumber": {
"type": "string",
"nullable": true
},
"canReadAccountNumber": {
"type": "boolean"
},
"maskedAccountNumber": {
"type": "string",
"nullable": true
},
"accountNumber": {
"type": "string",
"nullable": true
},
"accountTypeId": {
"type": "string",
"nullable": true
},
"accountType": {
"type": "string",
"nullable": true
},
"datePreNoteSent": {
"type": "string",
"format": "date-time",
"nullable": true
},
"datePreNoteApproved": {
"type": "string",
"format": "date-time",
"nullable": true
},
"datePreNoteDisapproved": {
"type": "string",
"format": "date-time",
"nullable": true
},
"misc1": {
"type": "string",
"nullable": true
},
"misc2": {
"type": "string",
"nullable": true
},
"misc3": {
"type": "string",
"nullable": true
},
"monthlyPayCycleId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"monthlyPayCycle": {
"type": "string",
"nullable": true
},
"levyDependents": {
"type": "integer",
"format": "int32"
},
"deductGreatestRuleCase": {
"type": "boolean"
},
"requiresAuthority": {
"type": "boolean"
},
"isDirectDepositAdjustment": {
"type": "boolean"
},
"isHourlyAdjustment": {
"type": "boolean"
},
"isAdjustmentToNet": {
"type": "boolean"
},
"isAdjustmentToGross": {
"type": "boolean"
},
"usesRuleCases": {
"type": "boolean"
},
"ruleCases": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.Adjustments.Models.AdjustmentRuleCase"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.Adjustments.EmployeeAdjustmentsQuery.Result": {
"type": "object",
"properties": {
"employeeAdjustmentId": {
"type": "integer",
"format": "int32"
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"adjustmentId": {
"type": "integer",
"format": "int32"
},
"adjustment": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"employerId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"sequence": {
"type": "integer",
"format": "int32",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"lifetimeTotal": {
"type": "number",
"format": "double"
},
"yearToDateTotal": {
"type": "number",
"format": "double"
},
"monthToDateTotal": {
"type": "number",
"format": "double"
},
"weekToDateTotal": {
"type": "number",
"format": "double"
},
"canBeDeleted": {
"type": "boolean"
},
"isEarnedWageAccess": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.Adjustments.Models.AdjustmentRuleCase": {
"type": "object",
"properties": {
"ruleColumn": {
"type": "string",
"nullable": true
},
"ruleConstraintType": {
"type": "string",
"nullable": true
},
"takeValueAsPercentOfColumn": {
"type": "string",
"nullable": true
},
"takeMaximumValueAsPercentOfColumn": {
"type": "string",
"nullable": true
},
"ruleCaseId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"ruleColumnId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"ruleConstraintTypeId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"ruleComparisonValue": {
"type": "number",
"format": "double",
"nullable": true
},
"takeValueAsPercentOfColumnId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"takeValue": {
"type": "number",
"format": "double"
},
"takeMaximumValue": {
"type": "number",
"format": "double",
"nullable": true
},
"takeMaximumValueAsPercentOfColumnId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"takeAllOrNothing": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.AssignedEmployeeInterviewCategories.Result": {
"type": "object",
"properties": {
"categoryId": {
"type": "string",
"format": "uuid"
},
"category": {
"type": "string",
"nullable": true
},
"dateAssigned": {
"type": "string",
"format": "date-time"
},
"assignedByServiceRepId": {
"type": "integer",
"format": "int32"
},
"assignedByServiceRep": {
"type": "string",
"nullable": true
},
"dateModified": {
"type": "string",
"format": "date-time",
"nullable": true
},
"modifiedByServiceRepId": {
"type": "integer",
"format": "int32"
},
"modifiedByServiceRep": {
"type": "string",
"nullable": true
},
"dateCompleted": {
"type": "string",
"format": "date-time",
"nullable": true
},
"completedByServiceRepId": {
"type": "integer",
"format": "int32"
},
"completedByServiceRep": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.AssignedEmployeeInterviewQuestions.Result": {
"type": "object",
"properties": {
"questionId": {
"type": "string",
"format": "uuid"
},
"questionName": {
"type": "string",
"nullable": true
},
"questionText": {
"type": "string",
"nullable": true
},
"questionDescription": {
"type": "string",
"nullable": true
},
"isRequired": {
"type": "boolean"
},
"isActive": {
"type": "boolean"
},
"answer": {
"type": "string",
"nullable": true
},
"possibleAnswers": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"dateAnswered": {
"type": "string",
"format": "date-time",
"nullable": true
},
"askedByServiceRepId": {
"type": "integer",
"format": "int32"
},
"askedByServiceRep": {
"type": "string",
"nullable": true
},
"dateModified": {
"type": "string",
"format": "date-time",
"nullable": true
},
"modifiedByServiceRepId": {
"type": "integer",
"format": "int32"
},
"modifiedByServiceRep": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.AssignedEmployeeInterviewWithDetails.DatabaseResult": {
"type": "object",
"properties": {
"categoryId": {
"type": "string",
"format": "uuid"
},
"category": {
"type": "string",
"nullable": true
},
"interviewId": {
"type": "integer",
"format": "int64"
},
"interviewName": {
"type": "string",
"nullable": true
},
"assignedQuestionCategoryId": {
"type": "integer",
"format": "int64"
},
"dateAssigned": {
"type": "string",
"format": "date-time"
},
"assignedByServiceRepId": {
"type": "integer",
"format": "int32"
},
"dateModified": {
"type": "string",
"format": "date-time",
"nullable": true
},
"modifiedByServiceRepId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"dateCompleted": {
"type": "string",
"format": "date-time",
"nullable": true
},
"completedByServiceRepId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"assignedByServiceRep": {
"type": "string",
"nullable": true
},
"modifiedByServiceRep": {
"type": "string",
"nullable": true
},
"completedByServiceRep": {
"type": "string",
"nullable": true
},
"totalResults": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.AssignedEmployeeInterviewWithDetails.InterviewQuestion": {
"type": "object",
"properties": {
"assignedQuestionCategoryId": {
"type": "integer",
"format": "int64"
},
"assignedQuestionAnswerId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"categoryId": {
"type": "string",
"format": "uuid"
},
"interviewId": {
"type": "integer",
"format": "int64"
},
"questionId": {
"type": "string",
"format": "uuid"
},
"questionName": {
"type": "string",
"nullable": true
},
"questionText": {
"type": "string",
"nullable": true
},
"questionDescription": {
"type": "string",
"nullable": true
},
"isRequired": {
"type": "boolean"
},
"isActive": {
"type": "boolean"
},
"answer": {
"type": "string",
"nullable": true
},
"possibleAnswers": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"dateAnswered": {
"type": "string",
"format": "date-time",
"nullable": true
},
"askedByServiceRepId": {
"type": "integer",
"format": "int32"
},
"askedByServiceRep": {
"type": "string",
"nullable": true
},
"dateModified": {
"type": "string",
"format": "date-time",
"nullable": true
},
"modifiedByServiceRepId": {
"type": "integer",
"format": "int32"
},
"modifiedByServiceRep": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.BackgroundChecksMetadata.Result": {
"type": "object",
"properties": {
"hasBackgroundCheckCredentials": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.CreateEmployeeAvailabilityCommand.Result": {
"type": "object",
"properties": {
"employeeAvailabilityId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"recurrenceId": {
"type": "integer",
"format": "int64",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.CreateEmployeeInterestCodeCommand.Result": {
"type": "object",
"properties": {
"employeeInterestCodeId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.CreateEmployeeRequiredDocument.Result": {
"type": "object",
"properties": {
"employeeRequiredDocumentId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.CreateEmployeeTax.Result": {
"type": "object",
"properties": {
"employeeTaxId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.CreateJobOrderJobBoardCandidateCommand.Result": {
"type": "object",
"properties": {
"jobOrderCandidateId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.CreateJobOrderJobBoardCandidateFromResumeCommand.Result": {
"type": "object",
"properties": {
"employeeId": {
"type": "integer",
"format": "int64"
},
"jobOrderCandidateId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.Education.CreateEmployeeEducationCommand.Result": {
"type": "object",
"properties": {
"educationId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.Education.EmployeeEducationDetailsQuery.Result": {
"type": "object",
"properties": {
"employeeEducationGuid": {
"type": "string",
"format": "uuid"
},
"educationId": {
"type": "integer",
"format": "int32"
},
"institutionAttended": {
"type": "string",
"nullable": true
},
"degreeAwarded": {
"type": "string",
"nullable": true
},
"enrollmentStatus": {
"type": "string",
"nullable": true
},
"other": {
"type": "string",
"nullable": true
},
"grade": {
"type": "number",
"format": "double",
"nullable": true
},
"dateAttendedStart": {
"type": "string",
"format": "date-time",
"nullable": true
},
"dateAttendedEnd": {
"type": "string",
"format": "date-time",
"nullable": true
},
"degreeDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"major": {
"type": "string",
"nullable": true
},
"contactInformation": {
"type": "string",
"nullable": true
},
"includeInBackgroundChecks": {
"type": "boolean"
},
"address": {
"$ref": "#/components/schemas/TempWorks.TwApi.Common.Models.Address"
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.Education.EmployeeEducationQuery.Result": {
"type": "object",
"properties": {
"educationId": {
"type": "integer",
"format": "int32"
},
"institutionAttended": {
"type": "string",
"nullable": true
},
"degreeAwarded": {
"type": "string",
"nullable": true
},
"other": {
"type": "string",
"nullable": true
},
"grade": {
"type": "number",
"format": "double",
"nullable": true
},
"dateAttendedStart": {
"type": "string",
"format": "date-time",
"nullable": true
},
"dateAttendedEnd": {
"type": "string",
"format": "date-time",
"nullable": true
},
"degreeDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"major": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.EmployeeACHHistoryListQuery.Result": {
"type": "object",
"properties": {
"achFeedHistoryId": {
"type": "integer",
"format": "int32"
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"employeeName": {
"type": "string",
"nullable": true
},
"payAmount": {
"type": "number",
"format": "double"
},
"originBankRoutingNumber": {
"type": "string",
"nullable": true
},
"destinationBankRoutingNumber": {
"type": "string",
"nullable": true
},
"destinationBankAccountNumber": {
"type": "string",
"nullable": true
},
"checkingOrSaving": {
"type": "string",
"nullable": true
},
"dateACHFileGenerated": {
"type": "string",
"format": "date-time"
},
"datePrenoteGenerated": {
"type": "string",
"format": "date-time"
},
"achRunId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.EmployeeAcaMetaQuery.Result": {
"type": "object",
"properties": {
"canUseAca": {
"type": "boolean"
},
"canFetchAca": {
"type": "boolean"
},
"canCreateAca": {
"type": "boolean"
},
"canUpdateAca": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.EmployeeAcaStatusQuery.Result": {
"type": "object",
"properties": {
"employeeId": {
"type": "integer",
"format": "int64"
},
"acaEmploymentStatusId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"acaEmploymentStatus": {
"type": "string",
"nullable": true
},
"acaHireDate": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.EmployeeAddressQuery.Result": {
"type": "object",
"properties": {
"address": {
"$ref": "#/components/schemas/TempWorks.TwApi.Common.Models.ExtendedAddress"
},
"isTemporaryMailingAddressActive": {
"type": "boolean"
},
"temporaryMailingAddress": {
"$ref": "#/components/schemas/TempWorks.TwApi.Common.Models.Address"
},
"employeeRootGuid": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.EmployeeAdjustmentHistoryListQuery.Result": {
"type": "object",
"properties": {
"adjustmentTypeId": {
"type": "integer",
"format": "int32"
},
"adjustmentName": {
"type": "string",
"nullable": true
},
"amount": {
"type": "number",
"format": "double"
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"checkId": {
"type": "integer",
"format": "int64"
},
"payrollAdjustmentId": {
"type": "integer",
"format": "int32"
},
"employeeName": {
"type": "string",
"nullable": true
},
"checkDate": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.EmployeeAvailabilityListQuery.EmployeePartialAvailability": {
"type": "object",
"properties": {
"startTime": {
"type": "string",
"format": "date-span"
},
"endTime": {
"type": "string",
"format": "date-span"
},
"partialAvailabilityId": {
"type": "integer",
"format": "int64"
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.EmployeeAvailabilityListQuery.Result": {
"type": "object",
"properties": {
"employeeId": {
"type": "integer",
"format": "int64"
},
"employeeAvailabilityId": {
"type": "integer",
"format": "int64"
},
"employeeAvailabilityGuid": {
"type": "string",
"format": "uuid"
},
"recurrenceId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"availabilityStatusId": {
"type": "integer",
"format": "int32"
},
"availabilityStatusDescription": {
"type": "string",
"nullable": true
},
"date": {
"type": "string",
"format": "date"
},
"note": {
"type": "string",
"nullable": true
},
"partialTimes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeAvailabilityListQuery.EmployeePartialAvailability"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.EmployeeAvailabilityQuery.EmployeePartialAvailability": {
"type": "object",
"properties": {
"startTime": {
"type": "string",
"format": "date-span"
},
"endTime": {
"type": "string",
"format": "date-span"
},
"partialAvailabilityId": {
"type": "integer",
"format": "int64"
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.EmployeeAvailabilityQuery.Result": {
"type": "object",
"properties": {
"employeeAvailabilityId": {
"type": "integer",
"format": "int64"
},
"employeeAvailabilityGuid": {
"type": "string",
"format": "uuid"
},
"recurrenceId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"availabilityStatusId": {
"type": "integer",
"format": "int32"
},
"availabilityStatusDescription": {
"type": "string",
"nullable": true
},
"date": {
"type": "string",
"format": "date"
},
"note": {
"type": "string",
"nullable": true
},
"partialTimes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeAvailabilityQuery.EmployeePartialAvailability"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.EmployeeAvailabilityRecurrenceQuery.EmployeePartialAvailability": {
"type": "object",
"properties": {
"startTime": {
"type": "string",
"format": "date-span"
},
"endTime": {
"type": "string",
"format": "date-span"
},
"partialRecurrenceId": {
"type": "integer",
"format": "int64"
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.EmployeeAvailabilityRecurrenceQuery.Result": {
"type": "object",
"properties": {
"recurrenceId": {
"type": "integer",
"format": "int64"
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"availabilityStatusId": {
"type": "integer",
"format": "int32"
},
"availabilityStatusDescription": {
"type": "string",
"nullable": true
},
"note": {
"type": "string",
"nullable": true
},
"partialTimes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeAvailabilityRecurrenceQuery.EmployeePartialAvailability"
},
"nullable": true
},
"recurrenceStartDate": {
"type": "string",
"format": "date"
},
"recurrenceEndDate": {
"type": "string",
"format": "date"
},
"recursEveryXWeeks": {
"type": "integer",
"format": "int32"
},
"recursOnSunday": {
"type": "boolean",
"nullable": true
},
"recursOnMonday": {
"type": "boolean",
"nullable": true
},
"recursOnTuesday": {
"type": "boolean",
"nullable": true
},
"recursOnWednesday": {
"type": "boolean",
"nullable": true
},
"recursOnThursday": {
"type": "boolean",
"nullable": true
},
"recursOnFriday": {
"type": "boolean",
"nullable": true
},
"recursOnSaturday": {
"type": "boolean",
"nullable": true
},
"employeeRecurringAvailabilityGuid": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.EmployeeBackgroundQuery.Result": {
"type": "object",
"properties": {
"howHeardOfId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"howHeardOf": {
"type": "string",
"nullable": true
},
"howHeardOfDetail": {
"type": "string",
"nullable": true
},
"pastResidences": {
"type": "string",
"nullable": true
},
"securityClearance": {
"type": "string",
"nullable": true
},
"convictions": {
"type": "string",
"nullable": true
},
"isConvictedFelon": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.EmployeeBasicTaxSetupMetadataQuery.Result": {
"type": "object",
"properties": {
"employeeId": {
"type": "integer",
"format": "int64"
},
"usaTaxSetup": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeBasicUsaTaxSetupMetadataQuery.Result"
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.EmployeeBasicTaxSetupQuery.Result": {
"type": "object",
"properties": {
"employeeId": {
"type": "integer",
"format": "int64"
},
"usaTaxSetup": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeBasicUsaTaxSetupQuery.Result"
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.EmployeeBasicUsaTaxSetupMetadataQuery.Result": {
"type": "object",
"properties": {
"psdCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.EmployeeBasicUsaTaxSetupQuery.Result": {
"type": "object",
"properties": {
"employeeRootGuid": {
"type": "string",
"format": "uuid"
},
"federalExemptions": {
"type": "integer",
"format": "int32"
},
"taxRegionExemptions": {
"type": "integer",
"format": "int32"
},
"additionalTaxWithholding": {
"type": "number",
"format": "double"
},
"dependents": {
"type": "integer",
"format": "int32"
},
"maritalTaxStatusId": {
"type": "integer",
"format": "int32"
},
"maritalTaxStatus": {
"type": "string",
"nullable": true
},
"taxRegion": {
"type": "string",
"nullable": true
},
"taxRegionJurisdiction": {
"type": "string",
"nullable": true
},
"taxRegionJurisdictionId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"isExemptFromCountyTax": {
"type": "boolean"
},
"taxCountyJurisdictionId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"taxCountyJurisdiction": {
"type": "string",
"nullable": true
},
"isExemptFromMunicipalityTax": {
"type": "boolean"
},
"taxMunicipalityJurisdictionId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"taxMunicipalityJurisdiction": {
"type": "string",
"nullable": true
},
"isExemptFromSchoolDistrictTax": {
"type": "boolean"
},
"taxSchoolDistrictJurisdictionId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"taxSchoolDistrictJurisdiction": {
"type": "string",
"nullable": true
},
"otherIncome": {
"type": "number",
"format": "double"
},
"dependentAllowance": {
"type": "number",
"format": "double"
},
"extraWithholding": {
"type": "number",
"format": "double"
},
"extraDeductions": {
"type": "number",
"format": "double"
},
"w4Year": {
"type": "integer",
"format": "int32"
},
"taxHigher": {
"type": "boolean"
},
"psdCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.EmployeeCandidaciesQuery.Result": {
"type": "object",
"properties": {
"candidateId": {
"type": "integer",
"format": "int64"
},
"orderId": {
"type": "integer",
"format": "int64"
},
"jobTitleId": {
"type": "integer",
"format": "int32"
},
"jobTitle": {
"type": "string",
"nullable": true
},
"customerId": {
"type": "integer",
"format": "int64"
},
"customerName": {
"type": "string",
"nullable": true
},
"departmentName": {
"type": "string",
"nullable": true
},
"candidateStatusId": {
"type": "integer",
"format": "int32"
},
"candidateStatus": {
"type": "string",
"nullable": true
},
"isActiveCandidate": {
"type": "boolean"
},
"statusActionDate": {
"type": "string",
"format": "date-time"
},
"rank": {
"type": "integer",
"format": "int32"
},
"comment": {
"type": "string",
"nullable": true
},
"interestCodeMatchPercentage": {
"type": "number",
"format": "double"
},
"resumeDocumentId": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.EmployeeCandidacySummary.Result": {
"type": "object",
"properties": {
"candidateStatusId": {
"type": "integer",
"format": "int32"
},
"candidateStatus": {
"type": "string",
"nullable": true
},
"numberOfCandidacies": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.EmployeeDriversLicense.Result": {
"type": "object",
"properties": {
"number": {
"type": "string",
"nullable": true
},
"region": {
"type": "string",
"nullable": true
},
"class": {
"type": "string",
"nullable": true
},
"expirationDate": {
"type": "string",
"format": "date",
"nullable": true
},
"noExpirationDateProvided": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.EmployeeEEOMetaQuery.Result": {
"type": "object",
"properties": {
"canRead": {
"type": "boolean"
},
"canUpdate": {
"type": "boolean"
},
"canCreate": {
"type": "boolean"
},
"recordExists": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.EmployeeEEOQuery.Result": {
"type": "object",
"properties": {
"employeeId": {
"type": "integer",
"format": "int64"
},
"birthPlace": {
"type": "string",
"nullable": true
},
"dateEntered": {
"type": "string",
"format": "date-time",
"nullable": true
},
"dateOfBirth": {
"type": "string",
"format": "date-time",
"nullable": true
},
"gender": {
"type": "string",
"nullable": true
},
"genderId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"i9DateVerified": {
"type": "string",
"format": "date-time",
"nullable": true
},
"isCitizen": {
"type": "boolean",
"nullable": true
},
"isDisabled": {
"type": "boolean"
},
"isEVerified": {
"type": "boolean"
},
"nationality": {
"type": "string",
"nullable": true
},
"nationalityId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"veteranStatus": {
"type": "string",
"nullable": true
},
"veteranStatusId": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.EmployeeElectronicPayMetaDataQuery.Result": {
"type": "object",
"properties": {
"currentElectronicPayBankAccountType": {
"type": "integer",
"format": "int32",
"nullable": true
},
"electronicPayExists": {
"type": "boolean"
},
"isInPayroll": {
"type": "boolean"
},
"canModify": {
"type": "boolean"
},
"isInStagedAchRun": {
"type": "boolean"
},
"isPayable": {
"type": "boolean"
},
"isAchSystemDisabled": {
"type": "boolean"
},
"isPrenoteProcessUsed": {
"type": "boolean"
},
"isPrenoteAutoPopulated": {
"type": "boolean"
},
"canModifyBankAccountAndRouting": {
"type": "boolean"
},
"canReadAccountNumber": {
"type": "boolean"
},
"paycardVendorID": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.EmployeeElectronicPayQuery.BankAccount": {
"type": "object",
"properties": {
"accountType": {
"type": "string",
"nullable": true
},
"accountTypeId": {
"type": "string",
"nullable": true
},
"routingNumber": {
"type": "string",
"nullable": true
},
"accountNumber": {
"type": "string",
"nullable": true
},
"maskedAccountNumber": {
"type": "string",
"nullable": true
},
"isPreNoteRequired": {
"type": "boolean"
},
"preNoteSent": {
"type": "string",
"format": "date-time",
"nullable": true
},
"preNoteApproved": {
"type": "string",
"format": "date-time",
"nullable": true
},
"preNoteDisapproved": {
"type": "string",
"format": "date-time",
"nullable": true
},
"roleNumber": {
"type": "string",
"nullable": true
},
"bankName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.EmployeeElectronicPayQuery.PaycardAccount": {
"type": "object",
"properties": {
"paycardVendorName": {
"type": "string",
"nullable": true
},
"paycardVendorId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"accountNumber": {
"type": "string",
"nullable": true
},
"maskedAccountNumber": {
"type": "string",
"nullable": true
},
"routingNumber": {
"type": "string",
"nullable": true
},
"expirationDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"paycardDateVerified": {
"type": "string",
"format": "date-time",
"nullable": true
},
"paycardVerifiedByServiceRepId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"paycardVerifiedByServiceRep": {
"type": "string",
"nullable": true
},
"payCardStatus": {
"type": "string",
"nullable": true
},
"proxyId": {
"type": "string",
"nullable": true
},
"enrollmentSummary": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeElectronicPayQuery.PaycardAccount.Enrollment"
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.EmployeeElectronicPayQuery.PaycardAccount.Enrollment": {
"type": "object",
"properties": {
"enrollmentId": {
"type": "string",
"nullable": true
},
"enrollmentLastCheckedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"isEnrollmentComplete": {
"type": "boolean"
},
"dateEnrollmentCreated": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.EmployeeElectronicPayQuery.Result": {
"type": "object",
"properties": {
"employeeId": {
"type": "integer",
"format": "int64"
},
"isActive": {
"type": "boolean"
},
"electronicPayBankTypeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"electronicPayBankType": {
"type": "string",
"nullable": true
},
"paycardAccount": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeElectronicPayQuery.PaycardAccount"
},
"bankAccount": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeElectronicPayQuery.BankAccount"
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.EmployeeGovernmentPersonalIdDuplicates.Result": {
"type": "object",
"properties": {
"employeeId": {
"type": "integer",
"format": "int64"
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"governmentPersonalId": {
"type": "string",
"nullable": true
},
"primaryPhoneNumber": {
"type": "string",
"nullable": true
},
"primaryPhoneNumberCountryCallingCode": {
"type": "integer",
"format": "int32",
"nullable": true
},
"primaryEmailAddress": {
"type": "string",
"nullable": true
},
"countryCode": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.EmployeeInterestCodeListQuery.Result": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"interestCodeId": {
"type": "integer",
"format": "int32"
},
"interestCode": {
"type": "string",
"nullable": true
},
"years": {
"type": "number",
"format": "double",
"nullable": true
},
"note": {
"type": "string",
"nullable": true
},
"isValidated": {
"type": "boolean"
},
"subCategoryId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"subCategory": {
"type": "string",
"nullable": true
},
"dateCreated": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.EmployeeInterestCodeQuery.Result": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"interestCodeId": {
"type": "integer",
"format": "int32"
},
"interestCode": {
"type": "string",
"nullable": true
},
"years": {
"type": "number",
"format": "double",
"nullable": true
},
"note": {
"type": "string",
"nullable": true
},
"isValidated": {
"type": "boolean"
},
"subCategoryId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"subCategory": {
"type": "string",
"nullable": true
},
"dateCreated": {
"type": "string",
"format": "date-time"
},
"employeeInterestCodeGuid": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.EmployeeInterviewDetails.InterviewCategory": {
"type": "object",
"properties": {
"assignedQuestionCategoryId": {
"type": "integer",
"format": "int64"
},
"categoryId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"questionsAndEmployeeAnswers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.AssignedEmployeeInterviewWithDetails.InterviewQuestion"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.EmployeeInterviewDetails.Result": {
"type": "object",
"properties": {
"interviewId": {
"type": "integer",
"format": "int64"
},
"interviewName": {
"type": "string",
"nullable": true
},
"dateModified": {
"type": "string",
"format": "date-time",
"nullable": true
},
"modifiedByServiceRep": {
"type": "string",
"nullable": true
},
"dateCompleted": {
"type": "string",
"format": "date-time",
"nullable": true
},
"completedByServiceRepId": {
"type": "string",
"nullable": true
},
"assignedInterviewGUID": {
"type": "string",
"format": "uuid"
},
"interviewCategories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.EmployeeInterviewDetails.InterviewCategory"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.EmployeeOfferDetailsQuery.Result": {
"type": "object",
"properties": {
"jobOfferId": {
"type": "integer",
"format": "int64"
},
"orderId": {
"type": "integer",
"format": "int64"
},
"assignmentId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"jobTitleId": {
"type": "integer",
"format": "int32"
},
"jobTitle": {
"type": "string",
"nullable": true
},
"publicJobTitle": {
"type": "string",
"nullable": true
},
"publicJobDescription": {
"type": "string",
"nullable": true
},
"jobDescription": {
"type": "string",
"nullable": true
},
"publicJobDescriptionContentType": {
"type": "string",
"nullable": true
},
"dateAdded": {
"type": "string",
"format": "date-time"
},
"candidateStatusId": {
"type": "integer",
"format": "int32"
},
"candidateStatus": {
"type": "string",
"nullable": true
},
"offerStatusTypeId": {
"$ref": "#/components/schemas/TwApi.Common.Enums.OfferStatusType"
},
"offerStatusType": {
"type": "string",
"nullable": true
},
"isActiveCandidate": {
"type": "boolean"
},
"statusActionDate": {
"type": "string",
"format": "date-time"
},
"startDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"expirationDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"startTime": {
"type": "string",
"nullable": true
},
"endTime": {
"type": "string",
"nullable": true
},
"rank": {
"type": "integer",
"format": "int32"
},
"positionsRemaining": {
"type": "integer",
"format": "int32"
},
"payRate": {
"type": "number",
"format": "double"
},
"jobOrderIsActive": {
"type": "boolean"
},
"dressCode": {
"type": "string",
"nullable": true
},
"safetyNotes": {
"type": "string",
"nullable": true
},
"directions": {
"type": "string",
"nullable": true
},
"shift": {
"type": "string",
"nullable": true
},
"shiftNote": {
"type": "string",
"nullable": true
},
"isScheduledForSunday": {
"type": "boolean"
},
"isScheduledForMonday": {
"type": "boolean"
},
"isScheduledForTuesday": {
"type": "boolean"
},
"isScheduledForWednesday": {
"type": "boolean"
},
"isScheduledForThursday": {
"type": "boolean"
},
"isScheduledForFriday": {
"type": "boolean"
},
"isScheduledForSaturday": {
"type": "boolean"
},
"worksiteId": {
"type": "integer",
"format": "int64"
},
"worksiteName": {
"type": "string",
"nullable": true
},
"street1": {
"type": "string",
"nullable": true
},
"street2": {
"type": "string",
"nullable": true
},
"municipality": {
"type": "string",
"nullable": true
},
"region": {
"type": "string",
"nullable": true
},
"postalCode": {
"type": "string",
"nullable": true
},
"countryCode": {
"type": "integer",
"format": "int32"
},
"country": {
"type": "string",
"nullable": true
},
"hideLocation": {
"type": "boolean"
},
"hideCityState": {
"type": "boolean"
},
"locationUncertaintyDistanceInMeters": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.EmployeeOffersQuery.Result": {
"type": "object",
"properties": {
"jobOfferId": {
"type": "integer",
"format": "int64"
},
"orderId": {
"type": "integer",
"format": "int64"
},
"jobTitleId": {
"type": "integer",
"format": "int32"
},
"jobTitle": {
"type": "string",
"nullable": true
},
"candidateStatusId": {
"type": "integer",
"format": "int32"
},
"candidateStatus": {
"type": "string",
"nullable": true
},
"offerStatusTypeId": {
"$ref": "#/components/schemas/TwApi.Common.Enums.OfferStatusType"
},
"offerStatusType": {
"type": "string",
"nullable": true
},
"isActiveCandidate": {
"type": "boolean"
},
"jobDescription": {
"type": "string",
"nullable": true
},
"startDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"startTime": {
"type": "string",
"nullable": true
},
"expirationDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"endTime": {
"type": "string",
"nullable": true
},
"statusActionDate": {
"type": "string",
"format": "date-time"
},
"rank": {
"type": "integer",
"format": "int32",
"nullable": true
},
"payRate": {
"type": "number",
"format": "double"
},
"positionsRemaining": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.EmployeePayCardHistoryListQuery.Result": {
"type": "object",
"properties": {
"paycardCheckId": {
"type": "integer",
"format": "int32"
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"payrollRunId": {
"type": "integer",
"format": "int64"
},
"datePosted": {
"type": "string",
"format": "date-time",
"nullable": true
},
"checkId": {
"type": "integer",
"format": "int64"
},
"checkNumber": {
"type": "integer",
"format": "int32",
"nullable": true
},
"checkDate": {
"type": "string",
"format": "date-time"
},
"paycardAccountNumber": {
"type": "string",
"nullable": true
},
"payAmount": {
"type": "number",
"format": "double"
},
"paycardVendorId": {
"type": "integer",
"format": "int32"
},
"paycardVendorName": {
"type": "string",
"nullable": true
},
"responseCode": {
"type": "string",
"nullable": true
},
"responseDescription": {
"type": "string",
"nullable": true
},
"responseFullDescription": {
"type": "string",
"nullable": true
},
"paycardProxyId": {
"type": "string",
"nullable": true
},
"errorMsg": {
"type": "string",
"nullable": true
},
"checkStatus": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.EmployeePayTransparencyListQuery.Result": {
"type": "object",
"properties": {
"employeePayTransparencyId": {
"type": "integer",
"format": "int32"
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"payTransparencyRaceId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"racePayTransparencyCollectionTypeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"racePayTransparencyCollectionTypeBasisId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"payTransparencyGenderId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"genderPayTransparencyCollectionTypeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"genderPayTransparencyCollectionTypeBasisId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"state": {
"type": "string",
"nullable": true
},
"dateCreated": {
"type": "string",
"format": "date-time"
},
"createdByServiceRepId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.EmployeePayTransparencyQuery.Result": {
"type": "object",
"properties": {
"employeePayTransparencyId": {
"type": "integer",
"format": "int32"
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"payTransparencyRaceId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"racePayTransparencyCollectionTypeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"racePayTransparencyCollectionTypeBasisId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"payTransparencyGenderId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"genderPayTransparencyCollectionTypeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"genderPayTransparencyCollectionTypeBasisId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"state": {
"type": "string",
"nullable": true
},
"dateCreated": {
"type": "string",
"format": "date-time"
},
"createdByServiceRepId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.EmployeePaycheckListQuery.Result": {
"type": "object",
"properties": {
"paycheckId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"stagedPaycheckId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"checkNumber": {
"type": "integer",
"format": "int32",
"nullable": true
},
"payrollRunId": {
"type": "integer",
"format": "int32"
},
"checkDate": {
"type": "string",
"format": "date-time"
},
"checkStatus": {
"type": "string",
"nullable": true
},
"paidToTheOrderOf": {
"type": "string",
"nullable": true
},
"isElectronicPay": {
"type": "boolean"
},
"grossPay": {
"type": "number",
"format": "double"
},
"totalAdjustmentAmountWithheld": {
"type": "number",
"format": "double"
},
"netPay": {
"type": "number",
"format": "double"
},
"totalEmployeeTaxAmountWithheld": {
"type": "number",
"format": "double"
},
"totalHours": {
"type": "number",
"format": "double"
},
"employerId": {
"type": "integer",
"format": "int32"
},
"employer": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.EmployeePayrollSetupQuery.Result": {
"type": "object",
"properties": {
"employeeId": {
"type": "integer",
"format": "int64"
},
"isPayReady": {
"type": "boolean"
},
"emailPaystubs": {
"type": "boolean"
},
"isElectronicPaySetupComplete": {
"type": "boolean"
},
"mailCheck": {
"type": "boolean"
},
"paycheckDeliveryCode": {
"type": "string",
"nullable": true
},
"payrollNote": {
"type": "string",
"nullable": true
},
"defaultPayRate": {
"type": "number",
"format": "double",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.EmployeeRequiredDocumentDetails.Result": {
"type": "object",
"properties": {
"employeeRequiredDocumentId": {
"type": "integer",
"format": "int32"
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"isActive": {
"type": "boolean"
},
"requiredDocumentTypeId": {
"type": "integer",
"format": "int32"
},
"requiredDocumentType": {
"type": "string",
"nullable": true
},
"requiredDocumentTypeCategoryId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"requiredDocumentTypeCategory": {
"type": "string",
"nullable": true
},
"requiredDocumentAuthorityId": {
"type": "integer",
"format": "int32"
},
"requiredDocumentAuthority": {
"type": "string",
"nullable": true
},
"licenseNumber": {
"type": "string",
"nullable": true
},
"issuedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"requestedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"receivedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"expirationDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"isRequired": {
"type": "boolean"
},
"notes": {
"type": "string",
"nullable": true
},
"statusId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"status": {
"type": "string",
"nullable": true
},
"linkedDocumentId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"canViewLinkedDocument": {
"type": "boolean"
},
"canDeleteLinkedDocument": {
"type": "boolean"
},
"isExpiringSoon": {
"type": "boolean"
},
"hasExpired": {
"type": "boolean"
},
"dateCreated": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.EmployeeRequiredDocumentList.Result": {
"type": "object",
"properties": {
"employeeRequiredDocumentId": {
"type": "integer",
"format": "int32"
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"requiredDocumentType": {
"type": "string",
"nullable": true
},
"requiredDocumentTypeId": {
"type": "integer",
"format": "int32"
},
"fileSize": {
"type": "integer",
"format": "int64",
"nullable": true
},
"requiredDocumentTypeCategory": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"receivedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"expirationDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"linkedDocumentId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"canViewLinkedDocument": {
"type": "boolean"
},
"canEditLinkedDocument": {
"type": "boolean"
},
"canDeleteLinkedDocument": {
"type": "boolean"
},
"isExpiringSoon": {
"type": "boolean"
},
"hasExpired": {
"type": "boolean"
},
"dateCreated": {
"type": "string",
"format": "date-time"
},
"requiredDocumentTypeCanSyncToSense": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.EmployeeResumeQuery.Model": {
"type": "object",
"properties": {
"docId": {
"type": "integer",
"format": "int32"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"description": {
"type": "string",
"nullable": true
},
"fileType": {
"type": "string",
"nullable": true
},
"version": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.EmployeeStatusInformationQuery.Result": {
"type": "object",
"properties": {
"washedStatusId": {
"type": "integer",
"format": "int32"
},
"washedStatus": {
"type": "string",
"nullable": true
},
"isWashed": {
"type": "boolean"
},
"employeeStatusId": {
"type": "string",
"nullable": true
},
"employeeStatus": {
"type": "string",
"nullable": true
},
"employmentCategoryId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"employmentCategory": {
"type": "string",
"nullable": true
},
"orderTypeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"orderType": {
"type": "string",
"nullable": true
},
"orientationGivenDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"anniversaryDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"interviewDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"interviewedBySrIdent": {
"type": "integer",
"format": "int32",
"nullable": true
},
"interviewedBy": {
"type": "string",
"nullable": true
},
"wotcEligibilityStatusId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"wotcEligibilityStatus": {
"type": "string",
"nullable": true
},
"isFaceVerificationOnboardingRequired": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.EmployeeStatusUpdateCommand.Result": {
"type": "object",
"properties": {
"statusChanged": {
"type": "boolean"
},
"additionalActionMessages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.StatusChange.AdditionalActionMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.EmployeeSummaryQuery.Result": {
"type": "object",
"properties": {
"employeeId": {
"type": "integer",
"format": "int64"
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"governmentPersonalId": {
"type": "string",
"nullable": true
},
"primaryPhoneNumberContactMethodId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"primaryPhoneNumber": {
"type": "string",
"nullable": true
},
"primaryPhoneNumberCountryCallingCode": {
"type": "integer",
"format": "int32",
"nullable": true
},
"primaryEmailAddressContactMethodId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"primaryEmailAddress": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"activationDate": {
"type": "string",
"format": "date-time"
},
"address": {
"$ref": "#/components/schemas/TempWorks.TwApi.Common.Models.Address"
},
"governmentPersonalIdIsScrubbed": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.EmployeeTax.Result": {
"type": "object",
"properties": {
"employeeTaxId": {
"type": "integer",
"format": "int32"
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"taxJurisdictionId": {
"type": "integer",
"format": "int32"
},
"taxJurisdiction": {
"type": "string",
"nullable": true
},
"employerId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"isExempt": {
"type": "boolean"
},
"isActive": {
"type": "boolean"
},
"taxPercentage": {
"type": "number",
"format": "double"
},
"taxAmount": {
"type": "number",
"format": "double"
},
"allowances": {
"type": "integer",
"format": "int32"
},
"additionalAllowances": {
"type": "integer",
"format": "int32"
},
"additionalWithholdingAmount": {
"type": "number",
"format": "double"
},
"alternativeStandardDeduction": {
"type": "number",
"format": "double",
"nullable": true
},
"dependents": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.EmployeeTaxList.Result": {
"type": "object",
"properties": {
"employeeTaxId": {
"type": "integer",
"format": "int32"
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"taxJurisdictionId": {
"type": "integer",
"format": "int32"
},
"taxJurisdiction": {
"type": "string",
"nullable": true
},
"compatibleTaxJurisdiction": {
"type": "string",
"nullable": true
},
"employerId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"employer": {
"type": "string",
"nullable": true
},
"isExempt": {
"type": "boolean"
},
"isActive": {
"type": "boolean"
},
"taxPercentage": {
"type": "number",
"format": "double"
},
"taxAmount": {
"type": "number",
"format": "double"
},
"allowances": {
"type": "integer",
"format": "int32"
},
"additionalAllowances": {
"type": "integer",
"format": "int32"
},
"additionalWithholdingAmount": {
"type": "number",
"format": "double"
},
"alternativeStandardDeduction": {
"type": "number",
"format": "double",
"nullable": true
},
"dependents": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.EmployeeTaxesToDateHistoryListQuery.Result": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"juris": {
"type": "string",
"nullable": true
},
"jurisGross": {
"type": "number",
"format": "double"
},
"amountTax": {
"type": "number",
"format": "double"
},
"amountTaxable": {
"type": "number",
"format": "double"
},
"nextJurisGross": {
"type": "number",
"format": "double"
},
"nextAmountTax": {
"type": "number",
"format": "double"
},
"nextAmountTaxable": {
"type": "number",
"format": "double"
},
"employerId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.EmployeeTransactionHistoryListQuery.Result": {
"type": "object",
"properties": {
"transactionId": {
"type": "integer",
"format": "int64"
},
"weekendBill": {
"type": "string",
"format": "date-time"
},
"weekendDate": {
"type": "string",
"format": "date-time"
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"customerId": {
"type": "integer",
"format": "int64"
},
"customerName": {
"type": "string",
"nullable": true
},
"departmentName": {
"type": "string",
"nullable": true
},
"jobOrderId": {
"type": "integer",
"format": "int64"
},
"assignmentId": {
"type": "integer",
"format": "int64"
},
"jobTitle": {
"type": "string",
"nullable": true
},
"payrollRunId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"totalBill": {
"type": "number",
"format": "double"
},
"gross": {
"type": "number",
"format": "double"
},
"checkId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"checkNumber": {
"type": "integer",
"format": "int32",
"nullable": true
},
"checkDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"regularHours": {
"type": "number",
"format": "double"
},
"regularPayRate": {
"type": "number",
"format": "double"
},
"overtimeHours": {
"type": "number",
"format": "double"
},
"overtimePayRate": {
"type": "number",
"format": "double"
},
"doubletimeHours": {
"type": "number",
"format": "double"
},
"doubletimePayRate": {
"type": "number",
"format": "double"
},
"salary": {
"type": "number",
"format": "double"
},
"unitPayRate": {
"type": "number",
"format": "double"
},
"units": {
"type": "number",
"format": "double"
},
"payCodeId": {
"type": "integer",
"format": "int32"
},
"payCode": {
"type": "string",
"nullable": true
},
"timecardAdjustmentTotalAmountBilled": {
"type": "number",
"format": "double",
"nullable": true
},
"timecardAdjustmentTotalAmountBilledPay": {
"type": "number",
"format": "double",
"nullable": true
},
"timecardAdjustmentTotalAmountUnbilledPay": {
"type": "number",
"format": "double",
"nullable": true
},
"branchName": {
"type": "string",
"nullable": true
},
"billRate": {
"type": "number",
"format": "double"
},
"contractorCost": {
"type": "number",
"format": "double"
},
"costCenter": {
"type": "string",
"nullable": true
},
"dateWorked": {
"type": "string",
"format": "date-time",
"nullable": true
},
"day1TotalHours": {
"type": "number",
"format": "double"
},
"day2TotalHours": {
"type": "number",
"format": "double"
},
"day3TotalHours": {
"type": "number",
"format": "double"
},
"day4TotalHours": {
"type": "number",
"format": "double"
},
"day5TotalHours": {
"type": "number",
"format": "double"
},
"day6TotalHours": {
"type": "number",
"format": "double"
},
"day7TotalHours": {
"type": "number",
"format": "double"
},
"doubletimeBillRate": {
"type": "number",
"format": "double"
},
"employeeName": {
"type": "string",
"nullable": true
},
"assignmentEndDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"invoiceId": {
"type": "integer",
"format": "int32"
},
"invoiceNumber": {
"type": "string",
"nullable": true
},
"overtimeBillRate": {
"type": "number",
"format": "double"
},
"purchaseOrderNumber": {
"type": "string",
"nullable": true
},
"salaryBillRate": {
"type": "number",
"format": "double"
},
"ssn": {
"type": "string",
"nullable": true
},
"assignmentStartDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"subEntity": {
"type": "string",
"nullable": true
},
"unitBillRate": {
"type": "number",
"format": "double"
},
"company": {
"type": "string",
"nullable": true
},
"workerCompCode": {
"type": "string",
"nullable": true
},
"worksiteName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.EmployeeWebAnnouncementListQuery.Result": {
"type": "object",
"properties": {
"hasBeenRead": {
"type": "boolean"
},
"id": {
"type": "integer",
"format": "int64"
},
"contactMessageRootGuid": {
"type": "string",
"format": "uuid"
},
"message": {
"type": "string",
"nullable": true
},
"date": {
"type": "string",
"format": "date-time"
},
"actionId": {
"type": "integer",
"format": "int32"
},
"action": {
"type": "string",
"nullable": true
},
"actionDescription": {
"type": "string",
"nullable": true
},
"taskId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"authorSrIdent": {
"type": "integer",
"format": "int32"
},
"author": {
"type": "string",
"nullable": true
},
"linkedDocumentsCount": {
"type": "integer",
"format": "int32"
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageLink"
},
"nullable": true
},
"primaryOriginTypeId": {
"$ref": "#/components/schemas/TwApi.Common.Enums.OriginType"
},
"primaryOriginId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"messageLinkedDocuments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageLinkedDocument"
},
"nullable": true
},
"viaIntegrationName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.InterestCodes.Models.EmployeeInterestCode": {
"type": "object",
"properties": {
"interestCodeId": {
"type": "integer",
"format": "int32"
},
"years": {
"type": "number",
"format": "double",
"nullable": true
},
"note": {
"type": "string",
"nullable": true
},
"isValidated": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.OrchestrateCreateEmployeeCommand.Result": {
"type": "object",
"properties": {
"employeeId": {
"type": "integer",
"format": "int64"
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.References.CreateEmployeeReferenceCommand.Result": {
"type": "object",
"properties": {
"referenceId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.References.EmployeeReferenceQuestionsQuery.Result": {
"type": "object",
"properties": {
"questionId": {
"type": "integer",
"format": "int64"
},
"referenceId": {
"type": "integer",
"format": "int64"
},
"questionText": {
"type": "string",
"nullable": true
},
"questionTypeId": {
"type": "integer",
"format": "int64"
},
"questionType": {
"type": "string",
"nullable": true
},
"sortOrder": {
"type": "integer",
"format": "int64"
},
"answerText": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.References.EmployeeReferencesQuery.Result": {
"type": "object",
"properties": {
"referenceId": {
"type": "integer",
"format": "int32"
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"name": {
"maxLength": 100,
"minLength": 0,
"type": "string",
"nullable": true
},
"phoneNumber": {
"maxLength": 256,
"minLength": 0,
"type": "string",
"nullable": true
},
"phoneNumberCountryCallingCode": {
"type": "integer",
"format": "int32",
"nullable": true
},
"email": {
"maxLength": 256,
"minLength": 0,
"type": "string",
"nullable": true
},
"relationship": {
"maxLength": 256,
"minLength": 0,
"type": "string",
"nullable": true
},
"companyName": {
"maxLength": 200,
"minLength": 0,
"type": "string",
"nullable": true
},
"dateReferenceChecked": {
"type": "string",
"format": "date-time",
"nullable": true
},
"referenceCheckedByServiceRepId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"referenceCheckedByServiceRep": {
"type": "string",
"nullable": true
},
"dateReferenceSent": {
"type": "string",
"format": "date-time",
"nullable": true
},
"referenceSentByServiceRepId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"referenceSentByServiceRep": {
"type": "string",
"nullable": true
},
"workHistoryId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"isOkayToContact": {
"type": "boolean"
},
"includeInBackgroundChecks": {
"type": "boolean"
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"referenceType": {
"type": "string",
"nullable": true
},
"address": {
"$ref": "#/components/schemas/TempWorks.TwApi.Common.Models.Address"
},
"notes": {
"maxLength": 2500,
"minLength": 0,
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.UploadEmployeeResumeCommand.Result": {
"type": "object",
"properties": {
"documentId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.WorkHistory.CreateEmployeeWorkHistoryCommand.Result": {
"type": "object",
"properties": {
"workHistoryId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.WorkHistory.EmployeeWorkHistoriesQuery.Result": {
"type": "object",
"properties": {
"workHistoryId": {
"type": "integer",
"format": "int32"
},
"startDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"endDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"employer": {
"type": "string",
"nullable": true
},
"employerAddress": {
"$ref": "#/components/schemas/TempWorks.TwApi.Common.Models.Address"
},
"employerAddressCombined": {
"type": "string",
"nullable": true
},
"phoneNumber": {
"type": "string",
"nullable": true
},
"phoneNumberCountryCallingCode": {
"type": "integer",
"format": "int32",
"nullable": true
},
"position": {
"type": "string",
"nullable": true
},
"pay": {
"type": "string",
"nullable": true
},
"isFullTime": {
"type": "boolean"
},
"isPartTime": {
"type": "boolean"
},
"isTemporaryJob": {
"type": "boolean"
},
"duties": {
"type": "string",
"nullable": true
},
"supervisor": {
"type": "string",
"nullable": true
},
"reasonForLeaving": {
"type": "string",
"nullable": true
},
"isOkayToContact": {
"type": "boolean"
},
"includeInBackgroundChecks": {
"type": "boolean"
},
"supervisorFirstName": {
"type": "string",
"nullable": true
},
"supervisorLastName": {
"type": "string",
"nullable": true
},
"supervisorTitle": {
"type": "string",
"nullable": true
},
"supervisorEmail": {
"type": "string",
"nullable": true
},
"references": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Employees.Service.Commands.WorkHistory.EmployeeWorkHistoriesQuery.Result.EmployeeReference"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.WorkHistory.EmployeeWorkHistoriesQuery.Result.EmployeeReference": {
"type": "object",
"properties": {
"referenceId": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true,
"deprecated": true
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Commands.WorkInterests.EmployeeWorkInterests.Result": {
"type": "object",
"properties": {
"employeeId": {
"type": "integer",
"format": "int64"
},
"availability": {
"type": "string",
"nullable": true
},
"preferredLocation": {
"type": "string",
"nullable": true
},
"hourlySalaryRequirement": {
"type": "number",
"format": "double",
"nullable": true
},
"isAvailableOnMonday": {
"type": "boolean"
},
"isAvailableOnTuesday": {
"type": "boolean"
},
"isAvailableOnWednesday": {
"type": "boolean"
},
"isAvailableOnThursday": {
"type": "boolean"
},
"isAvailableOnFriday": {
"type": "boolean"
},
"isAvailableOnSaturday": {
"type": "boolean"
},
"isAvailableOnSunday": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Queries.EmployeeOnboardingEmailTemplateDetails.Result": {
"type": "object",
"properties": {
"employeeId": {
"type": "integer",
"format": "int64"
},
"employeeFirstName": {
"type": "string",
"nullable": true
},
"employeeLastName": {
"type": "string",
"nullable": true
},
"employeePhone": {
"type": "string",
"nullable": true
},
"employeeEmail": {
"type": "string",
"nullable": true
},
"branchName": {
"type": "string",
"nullable": true
},
"branchId": {
"type": "string",
"nullable": true
},
"branchPhone": {
"type": "string",
"nullable": true
},
"branchEmail": {
"type": "string",
"nullable": true
},
"serviceRepName": {
"type": "string",
"nullable": true
},
"serviceRepPhone": {
"type": "string",
"nullable": true
},
"serviceRepEmail": {
"type": "string",
"nullable": true
},
"branchAddress": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Queries.GetEmployeeIdForEmployeeWebUserQuery.Result": {
"type": "object",
"properties": {
"employeeId": {
"type": "integer",
"format": "int64"
}
},
"additionalProperties": false
},
"TwApi.Services.Employees.Service.Queries.GetEmployeeMetadata.Result": {
"type": "object",
"properties": {
"hasAssignmentPayHistory": {
"type": "boolean"
},
"hasContactMethods": {
"type": "boolean"
},
"hasCustomData": {
"type": "boolean"
},
"hasDocuments": {
"type": "boolean"
},
"hasEducation": {
"type": "boolean"
},
"hasInterestCodes": {
"type": "boolean"
},
"hasInterviews": {
"type": "boolean"
},
"hasMessages": {
"type": "boolean"
},
"hasWorkHistory": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Employers.Service.Commands.GetEmployerDetails.Address": {
"required": [
"municipality",
"postalCode",
"region",
"street1"
],
"type": "object",
"properties": {
"street1": {
"type": "string",
"nullable": true
},
"street2": {
"type": "string",
"nullable": true
},
"municipality": {
"type": "string",
"nullable": true
},
"region": {
"type": "string",
"nullable": true
},
"postalCode": {
"type": "string",
"nullable": true
},
"countryCode": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Employers.Service.Commands.GetEmployerDetails.Result": {
"required": [
"address",
"employerId",
"employerName",
"federalEmployerIdentificationNumber",
"legalName"
],
"type": "object",
"properties": {
"employerId": {
"type": "integer",
"format": "int32"
},
"employerGuid": {
"type": "string",
"format": "uuid"
},
"employerName": {
"type": "string",
"nullable": true
},
"legalName": {
"type": "string",
"nullable": true
},
"federalEmployerIdentificationNumber": {
"type": "string",
"nullable": true
},
"address": {
"$ref": "#/components/schemas/TwApi.Services.Employers.Service.Commands.GetEmployerDetails.Address"
},
"phoneNumber": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.EmploymentVerification.API.Models.BackgroundCheckRequest": {
"required": [
"employeeIds"
],
"type": "object",
"properties": {
"employeeIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "List of employees on the order. \r\nIt is recommended that background checks are ordered on a per employee basis to allow for use of the Vendor Custom Data Fields."
},
"vendorCustomDataFields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.BackgroundCheckRequest.CustomData"
},
"description": "Vendor related custom data fields populated on each employee. \r\nCan be used to include the ClientReference Fields for First Advantage.",
"nullable": true
},
"packages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.BackgroundCheckRequest.Package"
},
"description": "List of packages to run for each employee Id. Review the Background Check Vendor List for support of Packages.",
"nullable": true
},
"screenings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.BackgroundCheckRequest.Screening"
},
"description": "List of screenings to run for each employee Id. Review the Background Check Vendor List for support of Screenings.\r\nNote regarding First Advantage. Screenings can only be added when there is at least one Package.",
"nullable": true
},
"filters": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.BackgroundCheckRequest.EmployeeProfileFilters"
}
},
"additionalProperties": false,
"description": "Request object for Background Check Orders and Validation."
},
"TwApi.Services.EmploymentVerification.API.Models.BackgroundCheckRequest.CustomData": {
"required": [
"backgroundCheckVendorId",
"propertyDefinitionId"
],
"type": "object",
"properties": {
"backgroundCheckVendorId": {
"type": "integer",
"description": "The Id of the background check vendor for the custom data field.",
"format": "int32"
},
"propertyDefinitionId": {
"minLength": 1,
"type": "string",
"description": "The Id of the custom data field. Valid values for the vendor can be found at /backgroundchecks/datalists/customdatafields"
},
"propertyValue": {
"type": "string",
"description": "The value of the custom data field.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Vendor specific custom data fields. These are used to pass along additional fields in related to the background check."
},
"TwApi.Services.EmploymentVerification.API.Models.BackgroundCheckRequest.EmployeeProfileFilters": {
"type": "object",
"properties": {
"includeWorkHistory": {
"type": "boolean",
"description": "When true, the work history is included in the background check request. \r\nIf a record will prevent the order submission, it will be automatically removed at the time of the order.\r\nUse the backgroundchecks/order/validate endpoint to determine what information will be excluded from the request."
},
"includeEducation": {
"type": "boolean",
"description": "When true, the education history is included in the background check request. \r\nIf a record will prevent the order submission, it will be automatically removed at the time of the order.\r\nUse the backgroundchecks/order/validate endpoint to determine what information will be excluded from the request."
},
"includeReferences": {
"type": "boolean",
"description": "When true, the references are included in the background check request. \r\nIf a record will prevent the order submission, it will be automatically removed at the time of the order.\r\nUse the backgroundchecks/order/validate endpoint to determine what information will be excluded from the request."
},
"includeDriversLicense": {
"type": "boolean",
"description": "When true, the drivers license will be included in the background check request. \r\nIf a record will prevent the order submission, it will be automatically removed at the time of the order.\r\nUse the /order/validate endpoint to determine what information will be excluded from the request."
}
},
"additionalProperties": false,
"description": "Filters on the what information is included in the background check request."
},
"TwApi.Services.EmploymentVerification.API.Models.BackgroundCheckRequest.Package": {
"required": [
"backgroundCheckVendorId",
"packageId"
],
"type": "object",
"properties": {
"packageId": {
"minLength": 1,
"type": "string",
"description": "The Id of the package."
},
"backgroundCheckVendorId": {
"type": "integer",
"description": "The Id of the background check vendor for the screening.",
"format": "int32"
}
},
"additionalProperties": false,
"description": "Packages to be ordered."
},
"TwApi.Services.EmploymentVerification.API.Models.BackgroundCheckRequest.Screening": {
"required": [
"backgroundCheckVendorId",
"screeningId"
],
"type": "object",
"properties": {
"screeningId": {
"minLength": 1,
"type": "string",
"description": "The Id of the screening."
},
"backgroundCheckVendorId": {
"type": "integer",
"description": "The Id of the background check vendor for the screening.",
"format": "int32"
}
},
"additionalProperties": false,
"description": "Screenings to be ordered."
},
"TwApi.Services.EmploymentVerification.API.Models.CaseNumberRequest": {
"required": [
"caseNumber"
],
"type": "object",
"properties": {
"caseNumber": {
"minLength": 1,
"type": "string",
"description": "The Case Number to retrieve from E-Verify."
}
},
"additionalProperties": false,
"description": "Reusable Request Data structure."
},
"TwApi.Services.EmploymentVerification.API.Models.CloseRequest": {
"required": [
"caseNumber"
],
"type": "object",
"properties": {
"caseClosureReasonCode": {
"type": "string",
"description": "The reason code for why the case is being closed. Acceptable values are provided by the Case Closure Reasons reference operation.",
"nullable": true
},
"otherReasonDescription": {
"type": "string",
"description": "If OTHER is provided in the \"case_closure_reason_code\" field, this field must contain free-form text explaining the reason for the case closure. \r\nOtherwise this field must be blank.",
"nullable": true
},
"currentlyEmployedReasonDescription": {
"type": "string",
"description": "If the eligibility statement is Final Non-Confirmation (FNC) and the employee is currently employed, this field must contain free-form text \r\nexplaining the reason why the employer will continue to employ the employee. Otherwise this field must be blank.",
"nullable": true
},
"caseNumber": {
"minLength": 1,
"type": "string",
"description": "The Case Number to retrieve from E-Verify."
}
},
"additionalProperties": false,
"description": "A valid case_closure_reason_code is required.\r\nIf OTHER is selected as the closure reason, the other_reason_description field is required to explain the reason for the case closure.\r\nIf EMPLOYEE_CONTINUES_TO_WORK_AFTER_FNC is selected as the case_closure_reason_code the currently_employed_reason_description field is\r\nrequired to explain the reason why the employer will continue to employ the employee."
},
"TwApi.Services.EmploymentVerification.API.Models.ConfirmDetailsField": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "The name of the field to be confirmed",
"nullable": true
},
"value": {
"type": "string",
"description": "The value of the field to be confirmed",
"nullable": true
}
},
"additionalProperties": false,
"description": "A key value pair of field names and values."
},
"TwApi.Services.EmploymentVerification.API.Models.ConfirmDetailsRequest": {
"type": "object",
"properties": {
"caseNumber": {
"type": "string",
"description": "The Case Number to submit to E-Verify.",
"nullable": true
},
"caseFields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.API.Models.ConfirmDetailsField"
},
"description": "A list of fields and values to be confirmed.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A Request of a list of field name / value pairs"
},
"TwApi.Services.EmploymentVerification.API.Models.CreateCaseRequest": {
"required": [
"caseCreatorEmailAddress",
"caseCreatorName",
"caseCreatorPhoneNumber",
"maskSocialSecurityNumber",
"ssn"
],
"type": "object",
"properties": {
"clientSoftwareVersion": {
"maxLength": 30,
"minLength": 0,
"type": "string",
"description": "E-Verify Software Version.",
"nullable": true
},
"duplicateContinueReason": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "A reason for continuing the case if the case is a duplicate. Used by v30/v31.",
"nullable": true
},
"firstName": {
"maxLength": 25,
"minLength": 0,
"pattern": "^[a-zA-Z'’\\- ]*$",
"type": "string",
"description": "Employee’s first name. Numbers and special characters are not allowed.Hyphens, spaces, and single quotes are allowed.",
"nullable": true
},
"middleInitial": {
"maxLength": 1,
"minLength": 0,
"pattern": "^[a-zA-Z]*$",
"type": "string",
"description": "The first letter of the middle name of the employee.",
"nullable": true
},
"lastName": {
"maxLength": 40,
"minLength": 0,
"pattern": "^[a-zA-Z'’\\- ]*$",
"type": "string",
"description": "Employee’s last name. May contain only alphabetic characters, spaces, and single quotes.\r\nOther special characters and numbers are not allowed.",
"nullable": true
},
"otherLastNamesUsed": {
"type": "array",
"items": {
"type": "string"
},
"description": "Other names that the employee may have used. May contain only alphabetic characters, spaces, and single quotes.\r\nOther special characters and numbers are not allowed.",
"nullable": true
},
"dateOfBirth": {
"type": "string",
"description": "Employee’s birth date. This cannot be a future date.",
"format": "date",
"nullable": true
},
"employeeEmailAddress": {
"pattern": "^.+@([a-zA-Z0-9]+(-[a-zA-Z0-9]+)*\\.)+[a-zA-Z]{2,}$",
"type": "string",
"description": "Employee’s email address. Used by v30/v31. Removed from v32 case creation (moved to confirm_details).",
"nullable": true
},
"phoneNumber": {
"pattern": "^\\d{10}$",
"type": "string",
"description": "Phone number. Must be 10 digits without hyphens.",
"nullable": true
},
"ssn": {
"minLength": 1,
"pattern": "^\\d{3}-\\d{2}-\\d{4}$",
"type": "string",
"description": "Employee’s Social Security Number. The SSN should contain only numbers with no spaces or special characters."
},
"alienNumber": {
"pattern": "^A?\\d{9}$",
"type": "string",
"description": "The 9-digit Alien Registration Number. If the presented DHS document has this field as 8 digits, \r\nthen zero fill from the left so that what is passed is exactly 9 digits. This field is required when:",
"nullable": true
},
"clientCompanyId": {
"type": "integer",
"description": "Client Company Account ID for an Employer Agent.",
"format": "int32",
"nullable": true
},
"citizenshipStatusCode": {
"type": "string",
"description": "Employee’s declared citizenship.",
"nullable": true
},
"documentATypeCode": {
"type": "string",
"description": "This ID describes the List A document type presented by the employee.",
"nullable": true
},
"documentBTypeCode": {
"type": "string",
"description": "This ID describes the List B document type presented by the employee.",
"nullable": true
},
"documentCTypeCode": {
"type": "string",
"description": "This ID describes the List C document type presented by the employee.",
"nullable": true
},
"documentSubTypeCode": {
"type": "string",
"description": "This ID describes an Document sub-type to differentiate a Driver’s license or ID case issued by a US State\r\nor outlying possession.",
"nullable": true
},
"i94Number": {
"pattern": "^[0-9A-Za-z]*$",
"type": "string",
"description": "This is an alien’s admission number.The Form I-94 number must be zero filled from the left so that it\r\nis exactly 11 characters. Either alien_number or i94_number is required when",
"nullable": true
},
"i551Number": {
"pattern": "^[a-zA-Z]{3}\\d{10}$",
"type": "string",
"description": "Form I-551 number must be exactly 3 alphabetic characters[A - Z] followed by 10 digits[0 - 9].",
"nullable": true
},
"i766Number": {
"pattern": "^[a-zA-Z]{3}\\d{10}$",
"type": "string",
"description": "Form I-766 number must be exactly 3 alphabetic characters[A - Z] followed by 10 digits[0 - 9].",
"nullable": true
},
"usPassportNumber": {
"maxLength": 9,
"minLength": 6,
"pattern": "^[A-Za-z0-9]*$",
"type": "string",
"description": "US Passport number must be between 6 and 9 alphanumeric characters.",
"nullable": true
},
"foreignPassportNumber": {
"maxLength": 12,
"minLength": 6,
"pattern": "^[A-Za-z0-9]*$",
"type": "string",
"description": "Foreign Passport number must be between 6 and 12 alphanumeric characters.",
"nullable": true
},
"documentBCNumber": {
"maxLength": 17,
"minLength": 0,
"pattern": "^[a-zA-Z0-9*-]*$",
"type": "string",
"description": "Driver’s license or ID card issued by a US State or outlying possession must be between 1-17 alphanumeric field.\r\nThis format is subject to change at any time to support any new State’s document number format.\r\nIf a new State has a document number format that is outside the current format, then the validation will\r\nbe made less restrictive to accommodate the new format.",
"nullable": true
},
"expirationDate": {
"type": "string",
"description": "The expiration date of the document must represent a valid date.",
"format": "date",
"nullable": true
},
"countryCode": {
"type": "string",
"description": "A country code in ISO 3166-1 alpha-3 standard format.\r\nAcceptable values are provided by the Countries reference operation.\r\nA foreign passport is an official document issued by the government of a foreign country.\r\nYou must specify the country that issued the passport, if a foreign passport number is specified.",
"nullable": true
},
"stateCode": {
"type": "string",
"description": "example: MS\r\nThis field contains the state that issued the driver’s license or state ID card that is being used as \r\na List B document.",
"nullable": true
},
"noExpirationDate": {
"type": "boolean",
"description": "This field is set to true when there is no expiration date on the DMV document (driver’s license, state ID card) \r\nbeing presented as a List B Document.If the document being presented contains an expiration date, this field \r\nmust be false and the date must be put in the expiration_date field.",
"nullable": true
},
"visaNumber": {
"maxLength": 8,
"minLength": 8,
"pattern": "^[a-zA-Z0-9*-]*$",
"type": "string",
"description": "This field is 8 alphanumeric characters long.",
"nullable": true
},
"employerCaseId": {
"maxLength": 40,
"minLength": 0,
"pattern": "^[a-zA-Z0-9\\-\\s]*$",
"type": "string",
"description": "This field is for the requesting employer to hold a related key into its system, if desired.",
"nullable": true
},
"dateOfHire": {
"type": "string",
"description": "The hire date for employees working for companies must \r\nbe between 1986-11-07 and current date + 365 days.Must be after date_of_birth.",
"format": "date",
"nullable": true
},
"reasonForDelayCode": {
"type": "string",
"description": "An employee must be verified through E-Verify within 3 days of hire date. If he/she is not, \r\na reason_for_delay_code must be provided.If an overdue reason is not provided, an error is returned.\r\nAcceptable values are provided by the Reasons for Delay reference operation.",
"nullable": true
},
"reasonForDelayDescription": {
"type": "string",
"description": "If OTHER is provided in the reason_for_delay_code field, this field must contain free-form text \r\nexplaining the reason for the late verification.Otherwise this field must be blank.",
"nullable": true
},
"sevisNumber": {
"pattern": "^N\\d{10}$",
"type": "string",
"description": "This field must contain the employee’s SEVIS Number if it was provided.",
"nullable": true
},
"caseCreatorName": {
"maxLength": 256,
"minLength": 0,
"pattern": "^[a-zA-Z'’\\- ]*$",
"type": "string",
"description": "The name of who created the case."
},
"caseCreatorEmailAddress": {
"minLength": 1,
"pattern": "^.+@([a-zA-Z0-9]+(-[a-zA-Z0-9]+)*\\.)+[a-zA-Z]{2,}$",
"type": "string",
"description": "The email address of who created the case. Must follow a valid e-mail format (e.g.user @domain.com).\r\ncase_creator_email_address cannot be the same as employee_email_address."
},
"caseCreatorPhoneNumber": {
"minLength": 1,
"pattern": "^\\d{10}$",
"type": "string",
"description": "The phone number of who created the case."
},
"caseCreatorPhoneNumberExtension": {
"maxLength": 8,
"minLength": 0,
"pattern": "^[0-9]*$",
"type": "string",
"description": "The phone number extension of who created the case.",
"nullable": true
},
"assignmentId": {
"type": "integer",
"description": "The optional assignment id this case is for.",
"format": "int64",
"nullable": true
},
"orderId": {
"type": "integer",
"description": "The optional order id this case is for.",
"format": "int64",
"nullable": true
},
"branchId": {
"type": "integer",
"description": "The branch id of the employee.",
"format": "int64",
"nullable": true
},
"srIdent": {
"type": "integer",
"description": "The service rep id of the creator of this case.",
"format": "int64",
"nullable": true
},
"maskSocialSecurityNumber": {
"type": "boolean",
"description": "If true return the Social Security Number masked to the last 4 digits"
}
},
"additionalProperties": false,
"description": "E-Verify Case Information to Create a Case with EVerify."
},
"TwApi.Services.EmploymentVerification.API.Models.DuplicateCheckRequest": {
"type": "object",
"properties": {
"clientCompanyId": {
"type": "integer",
"description": "Client Company Account ID for an Employer Agent.",
"format": "int32",
"nullable": true
},
"ssn": {
"type": "string",
"description": "Optional SSN to use instead of the Employees, for duplicate validation on Everify's side",
"nullable": true
}
},
"additionalProperties": false,
"description": "Request object for checking for duplicate cases."
},
"TwApi.Services.EmploymentVerification.API.Models.EditCaseRequest": {
"required": [
"caseCreatorEmailAddress",
"caseCreatorName",
"caseCreatorPhoneNumber",
"caseNumber",
"hasChanged",
"maskSocialSecurityNumber",
"ssn"
],
"type": "object",
"properties": {
"caseNumber": {
"minLength": 1,
"type": "string",
"description": "The Case Number to retrieve from E-Verify."
},
"hasChanged": {
"type": "boolean",
"description": "Indicator as to whether or not any of the case data has changed."
},
"clientSoftwareVersion": {
"maxLength": 30,
"minLength": 0,
"type": "string",
"description": "E-Verify Software Version.",
"nullable": true
},
"duplicateContinueReason": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "A reason for continuing the case if the case is a duplicate. Used by v30/v31.",
"nullable": true
},
"firstName": {
"maxLength": 25,
"minLength": 0,
"pattern": "^[a-zA-Z'’\\- ]*$",
"type": "string",
"description": "Employee’s first name. Numbers and special characters are not allowed.Hyphens, spaces, and single quotes are allowed.",
"nullable": true
},
"middleInitial": {
"maxLength": 1,
"minLength": 0,
"pattern": "^[a-zA-Z]*$",
"type": "string",
"description": "The first letter of the middle name of the employee.",
"nullable": true
},
"lastName": {
"maxLength": 40,
"minLength": 0,
"pattern": "^[a-zA-Z'’\\- ]*$",
"type": "string",
"description": "Employee’s last name. May contain only alphabetic characters, spaces, and single quotes.\r\nOther special characters and numbers are not allowed.",
"nullable": true
},
"otherLastNamesUsed": {
"type": "array",
"items": {
"type": "string"
},
"description": "Other names that the employee may have used. May contain only alphabetic characters, spaces, and single quotes.\r\nOther special characters and numbers are not allowed.",
"nullable": true
},
"dateOfBirth": {
"type": "string",
"description": "Employee’s birth date. This cannot be a future date.",
"format": "date",
"nullable": true
},
"employeeEmailAddress": {
"pattern": "^.+@([a-zA-Z0-9]+(-[a-zA-Z0-9]+)*\\.)+[a-zA-Z]{2,}$",
"type": "string",
"description": "Employee’s email address. Used by v30/v31. Removed from v32 case creation (moved to confirm_details).",
"nullable": true
},
"phoneNumber": {
"pattern": "^\\d{10}$",
"type": "string",
"description": "Phone number. Must be 10 digits without hyphens.",
"nullable": true
},
"ssn": {
"minLength": 1,
"pattern": "^\\d{3}-\\d{2}-\\d{4}$",
"type": "string",
"description": "Employee’s Social Security Number. The SSN should contain only numbers with no spaces or special characters."
},
"alienNumber": {
"pattern": "^A?\\d{9}$",
"type": "string",
"description": "The 9-digit Alien Registration Number. If the presented DHS document has this field as 8 digits, \r\nthen zero fill from the left so that what is passed is exactly 9 digits. This field is required when:",
"nullable": true
},
"clientCompanyId": {
"type": "integer",
"description": "Client Company Account ID for an Employer Agent.",
"format": "int32",
"nullable": true
},
"citizenshipStatusCode": {
"type": "string",
"description": "Employee’s declared citizenship.",
"nullable": true
},
"documentATypeCode": {
"type": "string",
"description": "This ID describes the List A document type presented by the employee.",
"nullable": true
},
"documentBTypeCode": {
"type": "string",
"description": "This ID describes the List B document type presented by the employee.",
"nullable": true
},
"documentCTypeCode": {
"type": "string",
"description": "This ID describes the List C document type presented by the employee.",
"nullable": true
},
"documentSubTypeCode": {
"type": "string",
"description": "This ID describes an Document sub-type to differentiate a Driver’s license or ID case issued by a US State\r\nor outlying possession.",
"nullable": true
},
"i94Number": {
"pattern": "^[0-9A-Za-z]*$",
"type": "string",
"description": "This is an alien’s admission number.The Form I-94 number must be zero filled from the left so that it\r\nis exactly 11 characters. Either alien_number or i94_number is required when",
"nullable": true
},
"i551Number": {
"pattern": "^[a-zA-Z]{3}\\d{10}$",
"type": "string",
"description": "Form I-551 number must be exactly 3 alphabetic characters[A - Z] followed by 10 digits[0 - 9].",
"nullable": true
},
"i766Number": {
"pattern": "^[a-zA-Z]{3}\\d{10}$",
"type": "string",
"description": "Form I-766 number must be exactly 3 alphabetic characters[A - Z] followed by 10 digits[0 - 9].",
"nullable": true
},
"usPassportNumber": {
"maxLength": 9,
"minLength": 6,
"pattern": "^[A-Za-z0-9]*$",
"type": "string",
"description": "US Passport number must be between 6 and 9 alphanumeric characters.",
"nullable": true
},
"foreignPassportNumber": {
"maxLength": 12,
"minLength": 6,
"pattern": "^[A-Za-z0-9]*$",
"type": "string",
"description": "Foreign Passport number must be between 6 and 12 alphanumeric characters.",
"nullable": true
},
"documentBCNumber": {
"maxLength": 17,
"minLength": 0,
"pattern": "^[a-zA-Z0-9*-]*$",
"type": "string",
"description": "Driver’s license or ID card issued by a US State or outlying possession must be between 1-17 alphanumeric field.\r\nThis format is subject to change at any time to support any new State’s document number format.\r\nIf a new State has a document number format that is outside the current format, then the validation will\r\nbe made less restrictive to accommodate the new format.",
"nullable": true
},
"expirationDate": {
"type": "string",
"description": "The expiration date of the document must represent a valid date.",
"format": "date",
"nullable": true
},
"countryCode": {
"type": "string",
"description": "A country code in ISO 3166-1 alpha-3 standard format.\r\nAcceptable values are provided by the Countries reference operation.\r\nA foreign passport is an official document issued by the government of a foreign country.\r\nYou must specify the country that issued the passport, if a foreign passport number is specified.",
"nullable": true
},
"stateCode": {
"type": "string",
"description": "example: MS\r\nThis field contains the state that issued the driver’s license or state ID card that is being used as \r\na List B document.",
"nullable": true
},
"noExpirationDate": {
"type": "boolean",
"description": "This field is set to true when there is no expiration date on the DMV document (driver’s license, state ID card) \r\nbeing presented as a List B Document.If the document being presented contains an expiration date, this field \r\nmust be false and the date must be put in the expiration_date field.",
"nullable": true
},
"visaNumber": {
"maxLength": 8,
"minLength": 8,
"pattern": "^[a-zA-Z0-9*-]*$",
"type": "string",
"description": "This field is 8 alphanumeric characters long.",
"nullable": true
},
"employerCaseId": {
"maxLength": 40,
"minLength": 0,
"pattern": "^[a-zA-Z0-9\\-\\s]*$",
"type": "string",
"description": "This field is for the requesting employer to hold a related key into its system, if desired.",
"nullable": true
},
"dateOfHire": {
"type": "string",
"description": "The hire date for employees working for companies must \r\nbe between 1986-11-07 and current date + 365 days.Must be after date_of_birth.",
"format": "date",
"nullable": true
},
"reasonForDelayCode": {
"type": "string",
"description": "An employee must be verified through E-Verify within 3 days of hire date. If he/she is not, \r\na reason_for_delay_code must be provided.If an overdue reason is not provided, an error is returned.\r\nAcceptable values are provided by the Reasons for Delay reference operation.",
"nullable": true
},
"reasonForDelayDescription": {
"type": "string",
"description": "If OTHER is provided in the reason_for_delay_code field, this field must contain free-form text \r\nexplaining the reason for the late verification.Otherwise this field must be blank.",
"nullable": true
},
"sevisNumber": {
"pattern": "^N\\d{10}$",
"type": "string",
"description": "This field must contain the employee’s SEVIS Number if it was provided.",
"nullable": true
},
"caseCreatorName": {
"maxLength": 256,
"minLength": 0,
"pattern": "^[a-zA-Z'’\\- ]*$",
"type": "string",
"description": "The name of who created the case."
},
"caseCreatorEmailAddress": {
"minLength": 1,
"pattern": "^.+@([a-zA-Z0-9]+(-[a-zA-Z0-9]+)*\\.)+[a-zA-Z]{2,}$",
"type": "string",
"description": "The email address of who created the case. Must follow a valid e-mail format (e.g.user @domain.com).\r\ncase_creator_email_address cannot be the same as employee_email_address."
},
"caseCreatorPhoneNumber": {
"minLength": 1,
"pattern": "^\\d{10}$",
"type": "string",
"description": "The phone number of who created the case."
},
"caseCreatorPhoneNumberExtension": {
"maxLength": 8,
"minLength": 0,
"pattern": "^[0-9]*$",
"type": "string",
"description": "The phone number extension of who created the case.",
"nullable": true
},
"assignmentId": {
"type": "integer",
"description": "The optional assignment id this case is for.",
"format": "int64",
"nullable": true
},
"orderId": {
"type": "integer",
"description": "The optional order id this case is for.",
"format": "int64",
"nullable": true
},
"branchId": {
"type": "integer",
"description": "The branch id of the employee.",
"format": "int64",
"nullable": true
},
"srIdent": {
"type": "integer",
"description": "The service rep id of the creator of this case.",
"format": "int64",
"nullable": true
},
"maskSocialSecurityNumber": {
"type": "boolean",
"description": "If true return the Social Security Number masked to the last 4 digits"
}
},
"additionalProperties": false,
"description": "Edit an E-Verify Case that is in DRAFT status."
},
"TwApi.Services.EmploymentVerification.API.Models.NoticeRequest": {
"required": [
"caseNumber",
"language"
],
"type": "object",
"properties": {
"language": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Enums.LanguageEnum"
},
"caseNumber": {
"minLength": 1,
"type": "string",
"description": "The Case Number to retrieve from E-Verify."
}
},
"additionalProperties": false,
"description": ""
},
"TwApi.Services.EmploymentVerification.API.Models.NotifiedRequest": {
"required": [
"caseNumber",
"employeeNotified"
],
"type": "object",
"properties": {
"employeeNotified": {
"type": "boolean",
"description": "Boolean value of whether or not employee has been notified of their TNC status."
},
"caseNumber": {
"minLength": 1,
"type": "string",
"description": "The Case Number to retrieve from E-Verify."
}
},
"additionalProperties": false,
"description": "Notify E-Verify that the case has been referred."
},
"TwApi.Services.EmploymentVerification.API.Models.PhotoMatchRequest": {
"required": [
"caseNumber",
"photoMatch"
],
"type": "object",
"properties": {
"photoMatch": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Enums.PhotoMatchEnum"
},
"caseNumber": {
"minLength": 1,
"type": "string",
"description": "The Case Number to retrieve from E-Verify."
}
},
"additionalProperties": false,
"description": "Request to confirm photo matching."
},
"TwApi.Services.EmploymentVerification.API.Models.RetrieveCaseRequest": {
"required": [
"caseNumber",
"maskSocialSecurityNumber"
],
"type": "object",
"properties": {
"maskSocialSecurityNumber": {
"type": "boolean",
"description": "If true return the Social Security Number masked to the last 4 digits"
},
"caseNumber": {
"minLength": 1,
"type": "string",
"description": "The Case Number to retrieve from E-Verify."
}
},
"additionalProperties": false,
"description": "Retrieve E-Verify Case Information from EVerify."
},
"TwApi.Services.EmploymentVerification.API.Models.UpdatedRequest": {
"type": "object",
"properties": {
"numberOfRecords": {
"type": "integer",
"description": "Number of cases to return. (Default 500)",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": "Get Cases that have been updated for synchronization."
},
"TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Commands.BackgroundCheckVendorCustomDataFields.Result": {
"type": "object",
"properties": {
"backgroundCheckVendorId": {
"type": "integer",
"format": "int32"
},
"propertyDefinitionId": {
"type": "string",
"nullable": true
},
"propertyName": {
"type": "string",
"nullable": true
},
"propertyDescription": {
"type": "string",
"nullable": true
},
"defaultPropertyValue": {
"type": "string",
"nullable": true
},
"isRequired": {
"type": "boolean"
},
"propertyType": {
"type": "string",
"nullable": true
},
"hasDatalist": {
"type": "boolean"
},
"datalistValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Common.Models.DataListItem"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Commands.CreateBackgroundCheckOrders.Result": {
"type": "object",
"properties": {
"backgroundCheckIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Commands.Packages.PackageResult": {
"type": "object",
"properties": {
"packageId": {
"type": "string",
"nullable": true
},
"packageName": {
"type": "string",
"nullable": true
},
"vendor": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Commands.Packages.PackageResult.BackgroundCheckVendor"
}
},
"additionalProperties": false
},
"TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Commands.Packages.PackageResult.BackgroundCheckVendor": {
"type": "object",
"properties": {
"backgroundCheckVendorId": {
"type": "integer",
"format": "int32"
},
"vendorName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Commands.Screenings.ScreeningResult": {
"type": "object",
"properties": {
"screeningId": {
"type": "string",
"nullable": true
},
"screeningName": {
"type": "string",
"nullable": true
},
"vendor": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Commands.Screenings.ScreeningResult.BackgroundCheckVendor"
}
},
"additionalProperties": false
},
"TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Commands.Screenings.ScreeningResult.BackgroundCheckVendor": {
"type": "object",
"properties": {
"backgroundCheckVendorId": {
"type": "integer",
"format": "int32"
},
"vendorName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Common.BackgroundCheckReportLocation.Result": {
"type": "object",
"properties": {
"reportLocation": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Common.BackgroundCheckVendors.Result": {
"type": "object",
"properties": {
"backgroundCheckVendorId": {
"type": "integer",
"format": "int32"
},
"vendorName": {
"type": "string",
"nullable": true
},
"hasPackages": {
"type": "boolean"
},
"hasIndividualScreenings": {
"type": "boolean"
},
"hasCustomDataFields": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.EmploymentVerification.Service.BackgroundChecks.Common.Models.DataListItem": {
"type": "object",
"properties": {
"value": {
"type": "string",
"nullable": true
},
"displayValue": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.EmploymentVerification.Service.Everify.Commands.AlertCountsQuery.Response": {
"type": "object",
"properties": {
"casesToBeClosed": {
"type": "integer",
"format": "int32"
},
"workDocsExpiring": {
"type": "integer",
"format": "int32"
},
"casesWithNewUpdates": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.EmploymentVerification.Service.Everify.Commands.StatusQuery.Response": {
"type": "object",
"properties": {
"credentialsAreMissing": {
"type": "boolean"
},
"serviceIsAvailable": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.EmploymentVerification.Service.Everify.Enums.FilterEnum": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
7
],
"type": "integer",
"format": "int32"
},
"TwApi.Services.EmploymentVerification.Service.Everify.Enums.LanguageEnum": {
"enum": [
0,
1
],
"type": "integer",
"format": "int32"
},
"TwApi.Services.EmploymentVerification.Service.Everify.Enums.PasswordStatus": {
"enum": [
0,
1,
2
],
"type": "integer",
"format": "int32"
},
"TwApi.Services.EmploymentVerification.Service.Everify.Enums.PhotoMatchEnum": {
"enum": [
0,
1,
2
],
"type": "integer",
"format": "int32"
},
"TwApi.Services.EmploymentVerification.Service.Everify.Enums.SearchFieldEnum": {
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8
],
"type": "integer",
"format": "int32"
},
"TwApi.Services.EmploymentVerification.Service.Everify.Enums.SortFieldEnum": {
"enum": [
0,
1,
2,
3
],
"type": "integer",
"format": "int32"
},
"TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow": {
"type": "object",
"properties": {
"caseState": {
"type": "string",
"nullable": true
},
"data": {
"nullable": true
},
"otherData": {
"nullable": true
},
"metadata": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow.CaseMetaData"
},
"actions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow.Action"
},
"nullable": true
},
"success": {
"type": "boolean"
},
"caseNumber": {
"type": "string",
"nullable": true
},
"caseEligibilityStatement": {
"type": "string",
"nullable": true
},
"caseStatus": {
"type": "string",
"nullable": true
},
"caseStatusDisplay": {
"type": "string",
"nullable": true
},
"dhsReferralStatus": {
"type": "string",
"nullable": true
},
"ssaReferralStatus": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow.Action": {
"type": "object",
"properties": {
"title": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"caseAction": {
"type": "string",
"nullable": true
},
"caseActionName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"canValidate": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow.CaseMetaData": {
"type": "object",
"properties": {
"mostRecentCaseStatus": {
"type": "string",
"nullable": true
},
"mostRecentCaseEligibilityStatment": {
"type": "string",
"nullable": true
},
"isEverifyEnabled": {
"type": "boolean"
},
"canViewCase": {
"type": "boolean"
},
"canAdministrateCase": {
"type": "boolean"
},
"canNotAdministrateCaseMessage": {
"type": "string",
"nullable": true
},
"canCreateNewCase": {
"type": "boolean",
"readOnly": true
},
"isClosed": {
"type": "boolean"
},
"passwordWarning": {
"type": "string",
"nullable": true
},
"hasPasswordWarning": {
"type": "boolean"
},
"passwordStatus": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Enums.PasswordStatus"
},
"openCases": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow.OpenCase, EmploymentVerification.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
},
"overdueHireDate": {
"type": "string",
"format": "date",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow.OpenCase": {
"type": "object",
"properties": {
"caseNumber": {
"type": "string",
"nullable": true
},
"caseStatus": {
"type": "string",
"nullable": true
},
"caseStatusDisplay": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.EmploymentVerification.Service.Everify.Models.CasesSearchResultItem": {
"type": "object",
"properties": {
"caseNumber": {
"type": "string",
"nullable": true
},
"caseEligibilityStatement": {
"type": "string",
"nullable": true
},
"caseStatus": {
"type": "string",
"nullable": true
},
"caseStatusDisplay": {
"type": "string",
"nullable": true
},
"dhsReferralStatus": {
"type": "string",
"nullable": true
},
"ssaReferralStatus": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"employeeId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"branchName": {
"type": "string",
"nullable": true
},
"twFirstName": {
"type": "string",
"nullable": true
},
"twLastName": {
"type": "string",
"nullable": true
},
"ssn": {
"type": "string",
"nullable": true
},
"dateOfHire": {
"type": "string",
"format": "date-time"
},
"clientCompanyId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"accountName": {
"type": "string",
"nullable": true
},
"createdBy": {
"type": "string",
"nullable": true
},
"createdDate": {
"type": "string",
"format": "date-time"
},
"submittedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"caseNotFoundInTw": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.EmploymentVerification.Service.Everify.Models.DuplicateCheckResponseItem": {
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.DuplicateCheckResultItem"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.EmploymentVerification.Service.Everify.Models.DuplicateCheckResultItem": {
"type": "object",
"properties": {
"caseNumber": {
"type": "string",
"nullable": true
},
"caseEligibilityStatement": {
"type": "string",
"nullable": true
},
"caseStatus": {
"type": "string",
"nullable": true
},
"caseStatusDisplay": {
"type": "string",
"nullable": true
},
"dhsReferralStatus": {
"type": "string",
"nullable": true
},
"ssaReferralStatus": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"ssn": {
"type": "string",
"nullable": true
},
"employeeId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"dateOfHire": {
"type": "string",
"format": "date-time"
},
"clientCompanyId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"accountName": {
"type": "string",
"nullable": true
},
"createdBy": {
"type": "string",
"nullable": true
},
"createdDate": {
"type": "string",
"format": "date-time"
},
"submittedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"createdByName": {
"type": "string",
"nullable": true
},
"isDuplicateOpenCase": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem": {
"type": "object",
"properties": {
"code": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.GenericListItem"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.EmploymentVerification.Service.Everify.Models.I9CaseFlatItem": {
"type": "object",
"properties": {
"caseNumber": {
"type": "string",
"nullable": true
},
"clientSoftwareVersion": {
"type": "string",
"nullable": true
},
"duplicateContinueReason": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"middleInitial": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"otherLastNamesUsed": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"dateOfBirth": {
"type": "string",
"format": "date-time",
"nullable": true
},
"employeeEmailAddress": {
"type": "string",
"nullable": true
},
"phoneNumber": {
"type": "string",
"nullable": true
},
"ssn": {
"type": "string",
"nullable": true
},
"alienNumber": {
"type": "string",
"nullable": true
},
"clientCompanyId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"citizenshipStatusCode": {
"type": "string",
"nullable": true
},
"documentATypeCode": {
"type": "string",
"nullable": true
},
"documentBTypeCode": {
"type": "string",
"nullable": true
},
"documentCTypeCode": {
"type": "string",
"nullable": true
},
"documentSubTypeCode": {
"type": "string",
"nullable": true
},
"i94Number": {
"type": "string",
"nullable": true
},
"i551Number": {
"type": "string",
"nullable": true
},
"i766Number": {
"type": "string",
"nullable": true
},
"usPassportNumber": {
"type": "string",
"nullable": true
},
"foreignPassportNumber": {
"type": "string",
"nullable": true
},
"documentBCNumber": {
"type": "string",
"nullable": true
},
"expirationDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"countryCode": {
"type": "string",
"nullable": true
},
"stateCode": {
"type": "string",
"nullable": true
},
"noExpirationDate": {
"type": "boolean",
"nullable": true
},
"visaNumber": {
"type": "string",
"nullable": true
},
"employerCaseId": {
"type": "string",
"nullable": true
},
"dateOfHire": {
"type": "string",
"format": "date-time",
"nullable": true
},
"reasonForDelayCode": {
"type": "string",
"nullable": true
},
"reasonForDelayDescription": {
"type": "string",
"nullable": true
},
"sevisNumber": {
"type": "string",
"nullable": true
},
"caseCreatorName": {
"type": "string",
"nullable": true
},
"caseCreatorEmailAddress": {
"type": "string",
"nullable": true
},
"caseCreatorPhoneNumber": {
"type": "string",
"nullable": true
},
"caseCreatorPhoneNumberExtension": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.EmploymentVerification.Service.Everify.Models.MultiCaseWorkflowResponse": {
"type": "object",
"properties": {
"updatedCases": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.EmploymentVerification.Service.Everify.Models.CaseWorkflow"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Enrollment.API.Models.AlabamaA4TaxForm2025Model": {
"required": [
"additionalWithholdingAmount",
"dependents",
"firstName",
"governmentPersonalIdentifier",
"lastName",
"marriedOrSingleHeadOfFamily",
"municipality",
"noWithholdings",
"postalCode",
"region",
"singleOrMarriedFilingSeparately",
"street1"
],
"type": "object",
"properties": {
"firstName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee first name as it appears on their Social Security card."
},
"lastName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee last name as it appears on their Social Security card."
},
"governmentPersonalIdentifier": {
"minLength": 1,
"pattern": "^\\d{3}-\\d{2}-\\d{4}$",
"type": "string",
"description": "Employee Social Security Number in the format xxx-xx-xxxx."
},
"street1": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee street address (line 1)."
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee Municipality."
},
"region": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Two-letter state or territory abbreviation (e.g., AZ)."
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"pattern": "^\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Postal/ZIP code in 5-digit or 5+4 format."
},
"noWithholdings": {
"pattern": "^0$",
"type": "string",
"description": "If you claim no personal exemption for yourself and wish to withold at the highest, write the figure \"0\", sign and date Form A4 and file it with your employer.",
"nullable": true
},
"singleOrMarriedFilingSeparately": {
"pattern": "^(S|MS)$",
"type": "string",
"description": "If you are SINGLE or MARRIED FILING SEPARATELY, a $1,500 personal exemption is allowed. Write the letter “S” if claiming the SINGLE exemption or “MS” if claiming the MARRIED FILING SEPARATELY exemption.",
"nullable": true
},
"marriedOrSingleHeadOfFamily": {
"pattern": "^(M|H)$",
"type": "string",
"description": "If you are MARRIED or SINGLE CLAIMING HEAD OF FAMILY, a $3,000 personal exemption is allowed. Write the letter “M” if you are claiming an exemption for both yourself and your spouse or “H” if you are single with qualifying dependents and are claiming the HEAD OF FAMILY exemption.",
"nullable": true
},
"dependents": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "Number of dependents (other than spouse) that you will provide more than one-half of the support for during the year.",
"format": "int32"
},
"additionalWithholdingAmount": {
"minimum": 0,
"type": "number",
"description": "Additional amount, if any, you want deducted each pay period.",
"format": "double"
}
},
"additionalProperties": false,
"description": "Request model for Alabama A-4 Tax Form for the year 2025."
},
"TwApi.Services.Enrollment.API.Models.ArizonaA4TaxForm2025Model": {
"required": [
"firstName",
"governmentPersonalIdentifier",
"lastName",
"municipality",
"postalCode",
"region",
"street1"
],
"type": "object",
"properties": {
"firstName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee first name as it appears on their Social Security card."
},
"lastName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee last name as it appears on their Social Security card."
},
"governmentPersonalIdentifier": {
"minLength": 1,
"pattern": "^\\d{3}-\\d{2}-\\d{4}$",
"type": "string",
"description": "Employee Social Security Number in the format xxx-xx-xxxx."
},
"street1": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee street address (line 1)."
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee Municipality."
},
"region": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Two-letter state or territory abbreviation (e.g., AZ)."
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"pattern": "^\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Postal/ZIP code in 5-digit or 5+4 format."
},
"box1": {
"type": "boolean",
"description": "Check this box to withhold a percentage of your taxable wages."
},
"box1Rate": {
"maximum": 3.5,
"minimum": 0.5,
"type": "number",
"description": "The percentage rate to withhold when Box1 is selected. Allowed values: 0.5, 1.0, 1.5, 2.0, 2.5, 3.0, 3.5",
"format": "double",
"nullable": true
},
"box1AdditionalWithholding": {
"type": "boolean",
"description": "Check to withhold an additional fixed amount when Box1 is selected."
},
"box1AdditionalWithholdingAmount": {
"minimum": 0,
"type": "number",
"description": "The additional fixed amount to withhold when Box1AdditionalWithholding is selected.",
"format": "double",
"nullable": true
},
"box2": {
"type": "boolean",
"description": "Check this box if you elect no state withholding (subject to Arizona rules). Mutually exclusive with Box1."
}
},
"additionalProperties": false,
"description": "Request model for Arizona A-4 Tax Form for the year 2025."
},
"TwApi.Services.Enrollment.API.Models.ArizonaA4TaxForm2026Model": {
"required": [
"firstName",
"governmentPersonalIdentifier",
"lastName",
"municipality",
"postalCode",
"region",
"street1"
],
"type": "object",
"properties": {
"firstName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee first name as it appears on their Social Security card."
},
"lastName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee last name as it appears on their Social Security card."
},
"governmentPersonalIdentifier": {
"minLength": 1,
"pattern": "^\\d{3}-\\d{2}-\\d{4}$",
"type": "string",
"description": "Employee Social Security Number in the format xxx-xx-xxxx."
},
"street1": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee street address (line 1)."
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee Municipality."
},
"region": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Two-letter state or territory abbreviation (e.g., AZ)."
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"pattern": "^\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Postal/ZIP code in 5-digit or 5+4 format."
},
"box1": {
"type": "boolean",
"description": "Check this box to withhold a percentage of your taxable wages."
},
"box1Rate": {
"maximum": 3.5,
"minimum": 0.5,
"type": "number",
"description": "The percentage rate to withhold when Box1 is selected. Allowed values: 0.5, 1.0, 1.5, 2.0, 2.5, 3.0, 3.5",
"format": "double",
"nullable": true
},
"box1AdditionalWithholding": {
"type": "boolean",
"description": "Check to withhold an additional fixed amount when Box1 is selected."
},
"box1AdditionalWithholdingAmount": {
"minimum": 0,
"type": "number",
"description": "The additional fixed amount to withhold when Box1AdditionalWithholding is selected.",
"format": "double",
"nullable": true
},
"box2": {
"type": "boolean",
"description": "Check this box if you elect no state withholding (subject to Arizona rules). Mutually exclusive with Box1."
}
},
"additionalProperties": false,
"description": "Request model for Arizona A-4 Tax Form for the year 2026."
},
"TwApi.Services.Enrollment.API.Models.ArkansasAR4ECTaxForm2025Model": {
"required": [
"additionalWithholdingAmount",
"firstName",
"governmentPersonalIdentifier",
"lastName",
"municipality",
"postalCode",
"region",
"street1"
],
"type": "object",
"properties": {
"firstName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee first name as it appears on their Social Security card."
},
"lastName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee last name as it appears on their Social Security card."
},
"governmentPersonalIdentifier": {
"minLength": 1,
"pattern": "^\\d{3}-\\d{2}-\\d{4}$",
"type": "string",
"description": "Employee Social Security Number in the format xxx-xx-xxxx."
},
"street1": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee street address (line 1)."
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee city."
},
"region": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Two-letter state or territory abbreviation (e.g., AZ)."
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"pattern": "^\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Postal/ZIP code in 5-digit or 5+4 format."
},
"singleDependentExemption": {
"type": "boolean",
"description": "Check this box if you just claim yourself"
},
"singleDependentExemptionClaim": {
"type": "integer",
"description": "Number of Exemptions you are claiming for a Single person (Either 1 or 0)",
"format": "int32",
"nullable": true
},
"marriedDependentExemption": {
"type": "boolean",
"description": "Check this box if you claim yourself and your spouse"
},
"marriedDependentExemptionClaim": {
"type": "integer",
"description": "Number of Exemptions you are claiming for a Married person (Either 2 or 0)",
"format": "int32",
"nullable": true
},
"headOfHouseholdExemption": {
"type": "boolean",
"description": "Check this box if you are head of household"
},
"headOfHouseholdExemptionClaim": {
"type": "integer",
"description": "Number of Exemptions you are claiming for a Head of Household (Either 2 or 0)",
"format": "int32",
"nullable": true
},
"dependents": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "Number of Children or Dependents",
"format": "int32",
"nullable": true
},
"totalExemptions": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "Total Exemptions for an Employee",
"format": "int32",
"nullable": true
},
"additionalWithholdingAmount": {
"minimum": 0,
"type": "number",
"description": "The additional fixed amount to withhold.",
"format": "double"
},
"lowIncomeTaxQualification": {
"type": "boolean",
"description": "You do qualify for low-income tax rates."
},
"regularIncomeTaxQualification": {
"type": "boolean",
"description": "You don't qualify for low-income tax rates."
},
"lowIncomeSingleFilingStatus": {
"type": "boolean",
"description": "If Box4 is Selected you have the ability to select this"
},
"lowIncomeMarriedFilingStatus": {
"type": "boolean",
"description": "If Box4 is Selected you have the ability to select this"
},
"lowIncomeHeadOfHouseholdStatus": {
"type": "boolean",
"description": "If Box4 is Selected you have the ability to select this"
}
},
"additionalProperties": false,
"description": "Request model for Arkansas AR4EC Tax Form for the year 2025."
},
"TwApi.Services.Enrollment.API.Models.ArkansasAR4ECTaxForm2026Model": {
"required": [
"additionalWithholdingAmount",
"firstName",
"governmentPersonalIdentifier",
"lastName",
"municipality",
"postalCode",
"region",
"street1"
],
"type": "object",
"properties": {
"firstName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee first name as it appears on their Social Security card."
},
"lastName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee last name as it appears on their Social Security card."
},
"governmentPersonalIdentifier": {
"minLength": 1,
"pattern": "^\\d{3}-\\d{2}-\\d{4}$",
"type": "string",
"description": "Employee Social Security Number in the format xxx-xx-xxxx."
},
"street1": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee street address (line 1)."
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee city."
},
"region": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Two-letter state or territory abbreviation (e.g., AR)."
},
"postalCode": {
"minLength": 1,
"pattern": "^\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Postal/ZIP code in 5-digit or 5+4 format."
},
"singleExemptionClaimed": {
"type": "boolean",
"description": "Checkbox 1a – check this box if you claim yourself (single exemption)."
},
"singleExemptionCount": {
"type": "integer",
"description": "Numeric right-column 1a – number of exemptions for a single person (1 or 0).",
"format": "int32",
"nullable": true
},
"marriedExemptionClaimed": {
"type": "boolean",
"description": "Checkbox 1b – check this box if you claim yourself and your spouse (married exemption)."
},
"marriedExemptionCount": {
"type": "integer",
"description": "Numeric right-column 1b – number of exemptions for a married person (2 or 0).",
"format": "int32",
"nullable": true
},
"headOfHouseholdExemptionClaimed": {
"type": "boolean",
"description": "Checkbox 1c – check this box if you are head of household."
},
"headOfHouseholdExemptionCount": {
"type": "integer",
"description": "Numeric right-column 1c – number of exemptions for head of household (2 or 0).",
"format": "int32",
"nullable": true
},
"dependents": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "Number of children or dependents.",
"format": "int32",
"nullable": true
},
"totalExemptions": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "Total exemptions for the employee.",
"format": "int32",
"nullable": true
},
"additionalWithholdingAmount": {
"minimum": 0,
"type": "number",
"description": "The additional fixed amount to withhold.",
"format": "double"
},
"lowIncomeQualifies": {
"type": "boolean",
"description": "Yes/No radio – true if the employee qualifies for low-income tax rates."
},
"lowIncomeSingleFilingStatus": {
"type": "boolean",
"description": "Check this box if qualifying for low-income tax rates as a single filer.\r\nMay be null when TwApi.Services.Enrollment.API.Models.ArkansasAR4ECTaxForm2026Model.LowIncomeQualifies is false.",
"nullable": true
},
"lowIncomeMarriedFilingStatus": {
"type": "boolean",
"description": "Check this box if qualifying for low-income tax rates filing as married.\r\nMay be null when TwApi.Services.Enrollment.API.Models.ArkansasAR4ECTaxForm2026Model.LowIncomeQualifies is false.",
"nullable": true
},
"lowIncomeHeadOfHouseholdStatus": {
"type": "boolean",
"description": "Check this box if qualifying for low-income tax rates as head of household.\r\nMay be null when TwApi.Services.Enrollment.API.Models.ArkansasAR4ECTaxForm2026Model.LowIncomeQualifies is false.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Request model for Arkansas AR4EC Tax Form for the year 2026 (R 12/04/2025)."
},
"TwApi.Services.Enrollment.API.Models.CaliforniaDE4TaxForm2025Model": {
"required": [
"employerStreet1",
"firstName",
"governmentPersonalIdentifier",
"headOfHousehold",
"lastName",
"marriedOneIncome",
"municipality",
"postalCode",
"region",
"singleOrMarriedTwoIncome",
"street1"
],
"type": "object",
"properties": {
"firstName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee first name as it appears on their Social Security card."
},
"lastName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee last name as it appears on their Social Security card."
},
"governmentPersonalIdentifier": {
"minLength": 1,
"pattern": "^\\d{3}-\\d{2}-\\d{4}$",
"type": "string",
"description": "Employee Social Security Number in the format xxx-xx-xxxx."
},
"street1": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee street address (line 1)."
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee Municipality."
},
"region": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Two-letter state or territory abbreviation (e.g., CA)."
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"pattern": "^\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Postal/ZIP code in 5-digit or 5+4 format."
},
"singleOrMarriedTwoIncome": {
"type": "boolean",
"description": "Filing status: Single or Married (two incomes)."
},
"marriedOneIncome": {
"type": "boolean",
"description": "Filing status: Married (one income)."
},
"headOfHousehold": {
"type": "boolean",
"description": "Filing status: Head of Household."
},
"step1AAllowances": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "Number of Regular Withholding Allowances (Worksheet A)",
"format": "int32",
"nullable": true
},
"step1BAllowances": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "Number of allowances from the Estimated Deductions (Worksheet B)",
"format": "int32",
"nullable": true
},
"step1CTotalAllowances": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "Total Number of Allowances you are claiming",
"format": "int32",
"nullable": true
},
"step2AdditionalWithholdingAmount": {
"minimum": 0,
"type": "number",
"description": "Additional amount, if any, you want withheld each pay period (if employer agrees), (Worksheet C)",
"format": "double",
"nullable": true
},
"step3Exempt": {
"type": "boolean",
"description": "I claim exemption from withholding for 2025, and I certify I meet both conditions for exemption"
},
"step4Exempt": {
"type": "boolean",
"description": "I certify under penalty of perjury that I am not subject to California withholding. I meet the conditions set forth under the Service Member Civil Relief Act, as amended by the Military Spouses Residency Relief Act and the Veterans Benefits and Transition Act of 2018."
},
"employerName": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employer Name",
"nullable": true
},
"employerStreet1": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employer street address (line 1)."
},
"employerMunicipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employer Municipality.",
"nullable": true
},
"employerRegion": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Two-letter state or territory abbreviation (e.g., CA).",
"nullable": true
},
"employerPostalCode": {
"maxLength": 10,
"minLength": 0,
"pattern": "^\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Employer Postal/ZIP code in 5-digit or 5+4 format.",
"nullable": true
},
"californiaEmployerPayrollTaxAccountNumber": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "California Employer Payroll Tax Account Number",
"nullable": true
}
},
"additionalProperties": false,
"description": "Request model for California state withholding Tax Form for the year 2025."
},
"TwApi.Services.Enrollment.API.Models.CaliforniaDE4TaxForm2026Model": {
"required": [
"employerStreet1",
"firstName",
"governmentPersonalIdentifier",
"headOfHousehold",
"lastName",
"marriedOneIncome",
"municipality",
"postalCode",
"region",
"singleOrMarriedTwoIncome",
"street1"
],
"type": "object",
"properties": {
"firstName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee first name as it appears on their Social Security card."
},
"lastName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee last name as it appears on their Social Security card."
},
"governmentPersonalIdentifier": {
"minLength": 1,
"pattern": "^\\d{3}-\\d{2}-\\d{4}$",
"type": "string",
"description": "Employee Social Security Number in the format xxx-xx-xxxx."
},
"street1": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee street address (line 1)."
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee Municipality."
},
"region": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Two-letter state or territory abbreviation (e.g., CA)."
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"pattern": "^\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Postal/ZIP code in 5-digit or 5+4 format."
},
"singleOrMarriedTwoIncome": {
"type": "boolean",
"description": "Filing status: Single or Married (two incomes)."
},
"marriedOneIncome": {
"type": "boolean",
"description": "Filing status: Married (one income)."
},
"headOfHousehold": {
"type": "boolean",
"description": "Filing status: Head of Household."
},
"step1AAllowances": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "Number of Regular Withholding Allowances (Worksheet A)",
"format": "int32",
"nullable": true
},
"step1BAllowances": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "Number of allowances from the Estimated Deductions (Worksheet B)",
"format": "int32",
"nullable": true
},
"step1CTotalAllowances": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "Total Number of Allowances you are claiming",
"format": "int32",
"nullable": true
},
"step2AdditionalWithholdingAmount": {
"minimum": 0,
"type": "number",
"description": "Additional amount, if any, you want withheld each pay period (if employer agrees), (Worksheet C)",
"format": "double",
"nullable": true
},
"step3Exempt": {
"type": "boolean",
"description": "I claim exemption from withholding for 2026, and I certify I meet both conditions for exemption"
},
"step4Exempt": {
"type": "boolean",
"description": "I certify under penalty of perjury that I am not subject to California withholding. I meet the conditions set\r\nforth under the Service Member Civil Relief Act, as amended by the Military Spouses Residency Relief Act\r\nand the Veterans Benefits and Transition Act of 2018."
},
"employerName": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employer Name",
"nullable": true
},
"employerStreet1": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employer street address (line 1)."
},
"employerMunicipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employer Municipality.",
"nullable": true
},
"employerRegion": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Two-letter state or territory abbreviation (e.g., CA).",
"nullable": true
},
"employerPostalCode": {
"maxLength": 10,
"minLength": 0,
"pattern": "^\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Employer Postal/ZIP code in 5-digit or 5+4 format.",
"nullable": true
},
"californiaEmployerPayrollTaxAccountNumber": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "California Employer Payroll Tax Account Number",
"nullable": true
}
},
"additionalProperties": false,
"description": "Request model for California state withholding Tax Form for the year 2026."
},
"TwApi.Services.Enrollment.API.Models.ColoradoDR0004TaxForm2025Model": {
"required": [
"additionalWithholdingAmount",
"annualWithholdingAllowance",
"firstName",
"governmentPersonalIdentifier",
"lastName",
"middleInitial",
"municipality",
"postalCode",
"region",
"street1"
],
"type": "object",
"properties": {
"lastName": {
"maxLength": 100,
"minLength": 1,
"type": "string",
"description": "Employee legal last name as it appears on their Social Security card."
},
"firstName": {
"maxLength": 100,
"minLength": 1,
"type": "string",
"description": "Employee legal first name as it appears on their Social Security card."
},
"middleInitial": {
"maxLength": 1,
"minLength": 0,
"type": "string",
"description": "Employee legal Middle Initial as it appears on their Social Security card."
},
"street1": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee street address (line 1)."
},
"governmentPersonalIdentifier": {
"minLength": 1,
"pattern": "^\\d{3}-\\d{2}-\\d{4}$",
"type": "string",
"description": "Employee Social Security Number in the format xxx-xx-xxxx."
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee city."
},
"region": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Two-letter state or territory abbreviation (e.g., CO)."
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"pattern": "^\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Postal/ZIP code in 5-digit or 5+4 format."
},
"annualWithholdingAllowance": {
"minimum": 0,
"type": "number",
"description": "The annual allowance to withhold.",
"format": "double"
},
"additionalWithholdingAmount": {
"minimum": 0,
"type": "number",
"description": "The additional fixed amount to withhold.",
"format": "double"
}
},
"additionalProperties": false,
"description": "Request model for Colorado DR0004 Tax Form for the year 2025."
},
"TwApi.Services.Enrollment.API.Models.ConnecticutCTW4TaxForm2024Model": {
"required": [
"box1WithholdingCode",
"firstName",
"governmentPersonalIdentifier",
"lastName",
"municipality",
"postalCode",
"region",
"street1"
],
"type": "object",
"properties": {
"firstName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee first name as it appears on their Social Security card."
},
"middleIntial": {
"maxLength": 1,
"minLength": 0,
"type": "string",
"description": "Employee middle initial as it appears on their Social Security card.",
"nullable": true
},
"lastName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee Last name as it appears on their Social Security card."
},
"governmentPersonalIdentifier": {
"minLength": 1,
"pattern": "^\\d{3}-\\d{2}-\\d{4}$",
"type": "string",
"description": "Employee Social Security Number in the format xxx-xx-xxxx."
},
"street1": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee street address (line 1)."
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee municipality(city)."
},
"region": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Two-letter state or territory abbreviation (e.g., CT)."
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"pattern": "^\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Postal/ZIP code in 5-digit or 5+4 format."
},
"box1WithholdingCode": {
"maxLength": 1,
"minLength": 0,
"pattern": "^[abcdefABCDEF]$",
"type": "string",
"description": "Valid Withholding Code from CT-W4 Form."
},
"box2AdditionalWithholding": {
"minimum": 0,
"type": "number",
"description": "Additional Amount to withhold. Must be 0 or greater with up to 2 decimal places.",
"format": "double",
"nullable": true
},
"box3ReducedWithholding": {
"minimum": 0,
"type": "number",
"description": "Reduce withholding by this amount. Must be 0 or greater with up to 2 decimal places.",
"format": "double"
},
"militarySpouseExemptionClaim": {
"type": "boolean",
"description": "Select this box if claiming a Military Spouse Residency Relief Act exemption."
},
"militarySpouseExemptionRegion": {
"maxLength": 2,
"minLength": 0,
"type": "string",
"description": "Enter the state of legal residence if claiming a Military Spouse Residency Relief Act exemption. Must be a valid two-letter state abbreviation when provided.",
"nullable": true
},
"newHireOrRehire": {
"type": "boolean",
"description": "Indicates whether the employee is a new hire or rehire. Not Implemented in 2024, but reserved for future use.",
"nullable": true
},
"employerBusinessName": {
"type": "string",
"description": "Employer Business Name as it appears on CT-W4 Form. Not Implemented in 2024, but reserved for future use.",
"nullable": true
},
"employerFederalIdentificationNumber": {
"type": "string",
"description": "Employer Federal Identification Number as it appears on CT-W4 Form. Not Implemented in 2024, but reserved for future use.",
"nullable": true
},
"employerBusinessAddress": {
"type": "string",
"description": "Employer Business Address as it appears on CT-W4 Form. Not Implemented in 2024, but reserved for future use.",
"nullable": true
},
"employerBusinessMunicipality": {
"type": "string",
"description": "Employer Business Municipality (city) as it appears on CT-W4 Form. Not Implemented in 2024, but reserved for future use.",
"nullable": true
},
"employerBusinessRegion": {
"type": "string",
"description": "Employer Business Region (state) as it appears on CT-W4 Form. Not Implemented in 2024, but reserved for future use.",
"nullable": true
},
"employerBusinessPostalCode": {
"type": "string",
"description": "Employer Business Postal Code as it appears on CT-W4 Form. Not Implemented in 2024, but reserved for future use.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Request model for Connecticut CT-W4 Tax Form for the year 2024."
},
"TwApi.Services.Enrollment.API.Models.ConnecticutCTW4TaxForm2026Model": {
"required": [
"box1WithholdingCode",
"firstName",
"governmentPersonalIdentifier",
"lastName",
"municipality",
"postalCode",
"region",
"street1"
],
"type": "object",
"properties": {
"firstName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee first name as it appears on their Social Security card."
},
"middleIntial": {
"maxLength": 1,
"minLength": 0,
"type": "string",
"description": "Employee middle initial as it appears on their Social Security card.",
"nullable": true
},
"lastName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee Last name as it appears on their Social Security card."
},
"governmentPersonalIdentifier": {
"minLength": 1,
"pattern": "^\\d{3}-\\d{2}-\\d{4}$",
"type": "string",
"description": "Employee Social Security Number in the format xxx-xx-xxxx."
},
"street1": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee street address (line 1)."
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee municipality(city)."
},
"region": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Two-letter state or territory abbreviation (e.g., CT)."
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"pattern": "^\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Postal/ZIP code in 5-digit or 5+4 format."
},
"box1WithholdingCode": {
"maxLength": 1,
"minLength": 0,
"pattern": "^[abcdefABCDEF]$",
"type": "string",
"description": "Valid Withholding Code from CT-W4 Form."
},
"box2AdditionalWithholding": {
"minimum": 0,
"type": "number",
"description": "Additional Amount to withhold. Must be 0 or greater with up to 2 decimal places.",
"format": "double",
"nullable": true
},
"box3ReducedWithholding": {
"minimum": 0,
"type": "number",
"description": "Reduce withholding by this amount. Must be 0 or greater with up to 2 decimal places.",
"format": "double"
},
"militarySpouseExemptionClaim": {
"type": "boolean",
"description": "Select this box if claiming a Military Spouse Residency Relief Act exemption."
},
"militarySpouseExemptionRegion": {
"maxLength": 2,
"minLength": 0,
"type": "string",
"description": "Enter the state of legal residence if claiming a Military Spouse Residency Relief Act exemption. Must be a valid two-letter state abbreviation when provided.",
"nullable": true
},
"newHireOrRehire": {
"type": "boolean",
"description": "Indicates whether the employee is a new hire or rehire.",
"nullable": true
},
"employerBusinessName": {
"type": "string",
"description": "Employer Business Name as it appears on CT-W4 Form.",
"nullable": true
},
"employerFederalIdentificationNumber": {
"type": "string",
"description": "Employer Federal Identification Number as it appears on CT-W4 Form.",
"nullable": true
},
"employerBusinessAddress": {
"type": "string",
"description": "Employer Business Address as it appears on CT-W4 Form.",
"nullable": true
},
"employerBusinessMunicipality": {
"type": "string",
"description": "Employer Business Municipality (city) as it appears on CT-W4 Form.",
"nullable": true
},
"employerBusinessRegion": {
"type": "string",
"description": "Employer Business Region (state) as it appears on CT-W4 Form.",
"nullable": true
},
"employerBusinessPostalCode": {
"type": "string",
"description": "Employer Business Postal Code as it appears on CT-W4 Form.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Request model for Connecticut CT-W4 Tax Form for the year 2026."
},
"TwApi.Services.Enrollment.API.Models.DelawareDEW4TaxForm2022Model": {
"required": [
"additionalWithholdingAmount",
"dependents",
"firstName",
"lastName",
"municipality",
"postalCode",
"region",
"street1"
],
"type": "object",
"properties": {
"box3Single": {
"type": "boolean",
"description": "Box 3 Marital Status Single - If selected then Married must be null or false",
"nullable": true
},
"box3Married": {
"type": "boolean",
"description": "Box 3 Marital Status Married - If selected then Single must be null or false",
"nullable": true
},
"firstName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee first name as it appears on their Social Security card."
},
"middleIntial": {
"maxLength": 1,
"minLength": 0,
"type": "string",
"description": "Employee middle initial as it appears on their Social Security card.",
"nullable": true
},
"lastName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee last name as it appears on their Social Security card."
},
"taxPayerId": {
"type": "string",
"description": "Employee Tax Payer Identification Number",
"nullable": true
},
"street1": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee street address (line 1)."
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee Municipality."
},
"region": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Two-letter state or territory abbreviation (e.g., AL)."
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"pattern": "^\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Postal/ZIP code in 5-digit or 5+4 format."
},
"dependents": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "Number of dependents (Yourself, spouse, others, dependent credits) you are claiming for Delaware state tax purposes See Worksheet.",
"format": "int32"
},
"additionalWithholdingAmount": {
"minimum": 0,
"type": "number",
"description": "Additional amount, if any, you want deducted each pay period.",
"format": "double"
}
},
"additionalProperties": false,
"description": "Request model for Delaware DE-W4 Tax Form for the year 2022."
},
"TwApi.Services.Enrollment.API.Models.DistrictOfColumbiaDCD4TaxForm2018Model": {
"required": [
"dependents",
"domicileOutsideDC",
"exempt",
"filingStatusHeadOfHousehold",
"filingStatusMarriedFilingJointly",
"filingStatusMarriedFilingSeparately",
"filingStatusMarriedFilingSeparatelySameReturn",
"filingStatusSingle",
"firstName",
"fullTimeStudent",
"governmentPersonalIdentifier",
"lastName",
"municipality",
"postalCode",
"region",
"street1",
"totalWithholdingAllowances"
],
"type": "object",
"properties": {
"firstName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee first name as it appears on their Social Security card."
},
"middleInitial": {
"maxLength": 1,
"minLength": 0,
"type": "string",
"description": "Employee middle initial.",
"nullable": true
},
"lastName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee last name as it appears on their Social Security card."
},
"governmentPersonalIdentifier": {
"minLength": 1,
"pattern": "^\\d{3}-\\d{2}-\\d{4}$",
"type": "string",
"description": "Employee Social Security Number in the format xxx-xx-xxxx."
},
"street1": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee home address (Number, Street, and apartment/suite number if applicable)."
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee city or town."
},
"region": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Two-letter state or territory abbreviation (e.g., DC)."
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"pattern": "^\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Postal/ZIP code in 5-digit or 5+4 format."
},
"filingStatusSingle": {
"type": "boolean",
"description": "Line 1 – Filing status: Single."
},
"filingStatusMarriedFilingJointly": {
"type": "boolean",
"description": "Line 1 – Filing status: Married/domestic partners filing jointly/qualifying widow(er) with dependent child."
},
"filingStatusMarriedFilingSeparately": {
"type": "boolean",
"description": "Line 1 – Filing status: Married filing separately."
},
"filingStatusHeadOfHousehold": {
"type": "boolean",
"description": "Line 1 – Filing status: Head of household."
},
"filingStatusMarriedFilingSeparatelySameReturn": {
"type": "boolean",
"description": "Line 1 – Filing status: Married/domestic partners filing separately on same return."
},
"totalWithholdingAllowances": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "Line 2 – Total number of withholding allowances from the D-4 worksheet (Sec. A, Line i + Sec. B, Line n).",
"format": "int32"
},
"additionalWithholding": {
"minimum": 0,
"type": "number",
"description": "Line 3 – Additional amount, if any, you want withheld from each paycheck.",
"format": "double",
"nullable": true
},
"exempt": {
"type": "boolean",
"description": "Line 4 – Exempt from withholding. If qualified, write \"EXEMPT\" in this box.\r\nI am exempt because: last year I did not owe any DC income tax and had a right to a full refund\r\nof all DC income tax withheld from me; and this year I do not expect to owe any DC income tax\r\nand expect a full refund of all DC income tax withheld from me; and I qualify for exempt status\r\non federal Form W-4."
},
"dependents": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "Line e – Number of dependents from the D-4 Withholding Allowance Worksheet, Section A.",
"format": "int32"
},
"domicileOutsideDC": {
"type": "boolean",
"description": "Line 5 – My domicile is a state other than the District of Columbia."
},
"domicileState": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "If DomicileOutsideDC is true, the name of the state of domicile (two-letter abbreviation).",
"nullable": true
},
"fullTimeStudent": {
"type": "boolean",
"description": "If claiming exemption from withholding, are you a full-time student?"
}
},
"additionalProperties": false,
"description": "Request model for District of Columbia D-4 (DC Withholding Allowance Certificate) for the 2018 form revision."
},
"TwApi.Services.Enrollment.API.Models.EnrollmentEmployeePaySetupRequest": {
"required": [
"payByDirectDeposit"
],
"type": "object",
"properties": {
"payByDirectDeposit": {
"type": "boolean",
"description": "Required. When true, the employee is opting into direct deposit. When false, the employee is opting into live check."
},
"routingNumber": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "The routing number of the bank where the employee's account is held.",
"nullable": true
},
"accountNumber": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "The account number of the employee's bank account.",
"nullable": true
},
"accountTypeId": {
"maxLength": 3,
"minLength": 0,
"type": "string",
"description": "The type of the employee's bank account. Valid options: Chk or Sav.",
"nullable": true
},
"secondaryDirectDepositAccounts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Enrollment.API.Models.SecondaryDirectDepositAccountRequest"
},
"description": "The secondary direct deposit accounts for the employee.",
"nullable": true
},
"emailPayStub": {
"type": "boolean",
"description": "When true, the employee's pay stub will be emailed to them. When false, the pay stub will not be emailed."
},
"markEmployeeAsPayReady": {
"type": "boolean",
"description": "When true, the employee will be marked as pay ready. When false, the employee will not be marked as pay ready."
}
},
"additionalProperties": false,
"description": "Request Model for enrolling an employee with direct deposit or opting into a live check."
},
"TwApi.Services.Enrollment.API.Models.FederalW4TaxForm2025Model": {
"required": [
"firstName",
"governmentPersonalIdentifier",
"isHeadOfHousehold",
"isMarriedFilingJointlyOrQualifyingSurvivingSpouse",
"isSingleOrMariedFilingSeparately",
"lastName",
"municipality",
"postalCode",
"region",
"step2TwoJobs",
"step3DependentsOther",
"step3DependentsUnder17",
"step3Total",
"step4Deductions",
"step4ExtraWithholding",
"step4IsExempt",
"step4OtherIncome",
"street1"
],
"type": "object",
"properties": {
"firstName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee first name."
},
"middleInitial": {
"maxLength": 1,
"minLength": 0,
"type": "string",
"description": "Employee middle initial (optional).",
"nullable": true
},
"lastName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee last name."
},
"governmentPersonalIdentifier": {
"minLength": 1,
"pattern": "^\\d{3}-\\d{2}-\\d{4}$",
"type": "string",
"description": "Employee Social Security Number in the format xxx-xx-xxxx."
},
"street1": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee street address (line 1)."
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee Municipality."
},
"region": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Two-letter state or territory abbreviation (e.g., AZ)."
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"pattern": "^\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Postal/ZIP code in 5-digit or 5+4 format."
},
"isSingleOrMariedFilingSeparately": {
"type": "boolean",
"description": "Filing status: Single or Married filing separately."
},
"isMarriedFilingJointlyOrQualifyingSurvivingSpouse": {
"type": "boolean",
"description": "Filing status: Married filing jointly or qualifying surviving spouse."
},
"isHeadOfHousehold": {
"type": "boolean",
"description": "Filing status: Head of household."
},
"step2TwoJobs": {
"type": "boolean",
"description": "If there are only two jobs total, you may check this box. Do the same on Form W-4 for the other job. This option is generally more accurate than(b) if pay at the lower paying job is more than half of the pay at the higher paying job.Otherwise, (b) is more accurate."
},
"step3DependentsUnder17": {
"minimum": 0,
"type": "number",
"description": "If your total income will be $200,000 or less ($400,000 or less if married filing jointly): Multiply the number of qualifying children under age 17 by $2,000",
"format": "double"
},
"step3DependentsOther": {
"minimum": 0,
"type": "number",
"description": "If your total income will be $200,000 or less ($400,000 or less if married filing jointly): Multiply the number of other dependents by $500",
"format": "double"
},
"step3Total": {
"minimum": 0,
"type": "number",
"description": "Add the amounts above for qualifying children and other dependents. You may add to this the amount of any other credits.Enter the total here",
"format": "double"
},
"step4OtherIncome": {
"minimum": 0,
"type": "number",
"description": "Other income (not from jobs). If you want tax withheld for other income you expect this year that won’t have withholding, enter the amount of other income here. This may include interest, dividends, and retirement income",
"format": "double"
},
"step4Deductions": {
"minimum": 0,
"type": "number",
"description": "Deductions. If you expect to claim deductions other than the standard deduction and want to reduce your withholding, use the Deductions Worksheet on page 3 and enter the result here",
"format": "double"
},
"step4ExtraWithholding": {
"minimum": 0,
"type": "number",
"description": "Extra withholding. Enter any additional tax you want withheld each pay period",
"format": "double"
},
"step4IsExempt": {
"type": "boolean",
"description": "Wether the employee is exempt from withholding. If you are exempt, do not complete any other steps on this form and write \"Exempt\" here"
}
},
"additionalProperties": false,
"description": "Request model for Federal W-4 Tax Form for the year 2025."
},
"TwApi.Services.Enrollment.API.Models.FederalW4TaxForm2026Model": {
"required": [
"firstName",
"governmentPersonalIdentifier",
"isHeadOfHousehold",
"isMarriedFilingJointlyOrQualifyingSurvivingSpouse",
"isSingleOrMariedFilingSeparately",
"lastName",
"municipality",
"postalCode",
"region",
"step2TwoJobs",
"step3DependentsOther",
"step3DependentsUnder17",
"step3Total",
"step4Deductions",
"step4ExtraWithholding",
"step4IsExempt",
"step4OtherIncome",
"street1"
],
"type": "object",
"properties": {
"firstName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee first name."
},
"middleInitial": {
"maxLength": 1,
"minLength": 0,
"type": "string",
"description": "Employee middle initial (optional).",
"nullable": true
},
"lastName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee last name."
},
"governmentPersonalIdentifier": {
"minLength": 1,
"pattern": "^\\d{3}-\\d{2}-\\d{4}$",
"type": "string",
"description": "Employee Social Security Number in the format xxx-xx-xxxx."
},
"street1": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee street address (line 1)."
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee Municipality."
},
"region": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Two-letter state or territory abbreviation (e.g., AZ)."
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"pattern": "^\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Postal/ZIP code in 5-digit or 5+4 format."
},
"isSingleOrMariedFilingSeparately": {
"type": "boolean",
"description": "Filing status: Single or Married filing separately."
},
"isMarriedFilingJointlyOrQualifyingSurvivingSpouse": {
"type": "boolean",
"description": "Filing status: Married filing jointly or qualifying surviving spouse."
},
"isHeadOfHousehold": {
"type": "boolean",
"description": "Filing status: Head of household."
},
"step2TwoJobs": {
"type": "boolean",
"description": "If there are only two jobs total, you may check this box. Do the same on Form W-4 for the other job. This option is generally more accurate than(b) if pay at the lower paying job is more than half of the pay at the higher paying job.Otherwise, (b) is more accurate."
},
"step3DependentsUnder17": {
"minimum": 0,
"type": "number",
"description": "If your total income will be $200,000 or less ($400,000 or less if married filing jointly): Multiply the number of qualifying children under age 17 by $2,200",
"format": "double"
},
"step3DependentsOther": {
"minimum": 0,
"type": "number",
"description": "If your total income will be $200,000 or less ($400,000 or less if married filing jointly): Multiply the number of other dependents by $500",
"format": "double"
},
"step3Total": {
"minimum": 0,
"type": "number",
"description": "Add the amounts above for qualifying children and other dependents. You may add to this the amount of any other credits.Enter the total here",
"format": "double"
},
"step4OtherIncome": {
"minimum": 0,
"type": "number",
"description": "Other income (not from jobs). If you want tax withheld for other income you expect this year that won’t have withholding, enter the amount of other income here. This may include interest, dividends, and retirement income",
"format": "double"
},
"step4Deductions": {
"minimum": 0,
"type": "number",
"description": "Deductions. If you expect to claim deductions other than the standard deduction and want to reduce your withholding, use the Deductions Worksheet on page 3 and enter the result here",
"format": "double"
},
"step4ExtraWithholding": {
"minimum": 0,
"type": "number",
"description": "Extra withholding. Enter any additional tax you want withheld each pay period",
"format": "double"
},
"step4IsExempt": {
"type": "boolean",
"description": "Whether the employee is exempt from withholding. If you are exempt, check this box."
}
},
"additionalProperties": false,
"description": "Request model for Federal W-4 Tax Form for the year 2026."
},
"TwApi.Services.Enrollment.API.Models.GeorgiaG4TaxForm2024Model": {
"required": [
"firstName",
"governmentPersonalIdentifier",
"lastName",
"municipality",
"postalCode",
"region",
"street1"
],
"type": "object",
"properties": {
"firstName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee first name."
},
"lastName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee last name."
},
"governmentPersonalIdentifier": {
"minLength": 1,
"pattern": "^\\d{3}-\\d{2}-\\d{4}$",
"type": "string",
"description": "Social Security Number in xxx-xx-xxxx format."
},
"street1": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Street address line 1."
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "City or municipality."
},
"region": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Two-letter state code."
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"pattern": "^\\d{5}(-\\d{4})?$",
"type": "string",
"description": "5-digit ZIP or ZIP+4 postal code."
},
"box4DependentAllowances": {
"maximum": 255,
"minimum": 0,
"type": "integer",
"description": "Number of dependent allowances claimed (Box 4). Must be zero or greater.",
"format": "int32",
"nullable": true
},
"box5AdjustmentAllowance": {
"maximum": 255,
"minimum": 0,
"type": "integer",
"description": "Adjustment allowances (Box 5). Must be zero or greater.",
"format": "int32",
"nullable": true
},
"box6AdditionalWithholdingAmount": {
"minimum": 0,
"type": "number",
"description": "Additional withholding amount in dollars (Box 6). Must be zero or greater.",
"format": "double",
"nullable": true
},
"box7MaritalStatus": {
"maxLength": 1,
"minLength": 0,
"pattern": "^(A|B|C|D)$",
"type": "string",
"description": "Marital status selection (Box 7): A, B, C, or D. Required unless exempt in Box 8.",
"nullable": true
},
"box7TotalAllowances": {
"maximum": 255,
"minimum": 0,
"type": "integer",
"description": "Total number of allowances (Box 7 total). Must be zero or greater. Required unless exempt in Box 8.",
"format": "int32",
"nullable": true
},
"box8AExemptFromWithholding": {
"type": "boolean",
"description": "Indicates exemption from withholding under Box 8A (Georgia only)."
},
"box8BExemptFromWithholding": {
"type": "boolean",
"description": "Indicates exemption from withholding under Box 8B (nonresident state exemption)."
},
"box8BStateOfResidence": {
"maxLength": 2,
"minLength": 2,
"pattern": "^[A-Z]{2}$",
"type": "string",
"description": "Employee state of residence for Box 8B. Two-letter state code if provided. Required when Box 8B is selected.",
"nullable": true
},
"box8BStateOfResidenceSpouse": {
"maxLength": 2,
"minLength": 2,
"pattern": "^[A-Z]{2}$",
"type": "string",
"description": "Spouse state of residence for Box 8B. Two-letter state code if provided. Required when Box 8B is selected.",
"nullable": true
},
"box9EmployerName": {
"maxLength": 100,
"minLength": 0,
"type": "string",
"description": "Employer name for Box 9.",
"nullable": true
},
"box9EmployerAddress": {
"maxLength": 200,
"minLength": 0,
"type": "string",
"description": "Employer address for Box 9.",
"nullable": true
},
"box9EmployerFEIN": {
"pattern": "^\\d{2}-\\d{7}$",
"type": "string",
"description": "Employer FEIN for Box 9 in NN-NNNNNNN format.",
"nullable": true
},
"box9EmployerWH": {
"maxLength": 15,
"minLength": 0,
"type": "string",
"description": "Employer Georgia withholding account number (Box 9). Alphanumeric up to 15 chars.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Request model for Georgia G-4 Tax Form for the year 2024."
},
"TwApi.Services.Enrollment.API.Models.HawaiiHW4TaxForm2025Model": {
"required": [
"firstName",
"governmentPersonalIdentifier",
"lastName",
"married",
"marriedButWithholdAtHigherSingleRate",
"municipality",
"postalCode",
"region",
"single",
"street1"
],
"type": "object",
"properties": {
"firstName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee first name as it appears on their Social Security card."
},
"lastName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee last name as it appears on their Social Security card."
},
"governmentPersonalIdentifier": {
"minLength": 1,
"pattern": "^\\d{3}-\\d{2}-\\d{4}$",
"type": "string",
"description": "Employee Social Security Number in the format xxx-xx-xxxx."
},
"street1": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee street address (line 1)."
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee Municipality (city)."
},
"region": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Two-letter state or territory abbreviation (e.g., HI)."
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"pattern": "^\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Postal/ZIP code in 5-digit or 5+4 format."
},
"single": {
"type": "boolean",
"description": "If the employee is filing as Single or Head of Household."
},
"married": {
"type": "boolean",
"description": "If the employee is filing as Married."
},
"marriedButWithholdAtHigherSingleRate": {
"type": "boolean",
"description": "If the employee is Married but withhold at higher Single rate."
},
"certifiedDisabledPerson": {
"type": "boolean",
"description": "Certified disabled person. (not subject to withholding)\r\nMutually exclusive with Line4TotalAllowances and Line5AdditionalWithholdingAmount."
},
"nonresidentMilitarySpouse": {
"type": "boolean",
"description": "Nonresident military spouse. (not subject to withholding)\r\nMutually exclusive with Line4TotalAllowances and Line5AdditionalWithholdingAmount."
},
"line4TotalAllowances": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "Total number of allowances you are claiming.",
"format": "int32",
"nullable": true
},
"line5AdditionalWithholdingAmount": {
"minimum": 0,
"type": "number",
"description": "Additional amount per pay period the employee wants withheld.",
"format": "double",
"nullable": true
},
"lineEDependents": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "Number of qualifying dependents claimed.",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": "Request model for Hawaii HW-4 Tax Form - 2025 revision."
},
"TwApi.Services.Enrollment.API.Models.IdahoW4TaxForm2025Model": {
"required": [
"firstName",
"governmentPersonalIdentifier",
"lastName",
"municipality",
"postalCode",
"region",
"street1"
],
"type": "object",
"properties": {
"firstName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee first name as it appears on their Social Security card."
},
"lastName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee last name as it appears on their Social Security card."
},
"governmentPersonalIdentifier": {
"minLength": 1,
"pattern": "^\\d{3}-\\d{2}-\\d{4}$",
"type": "string",
"description": "Employee Social Security Number in the format xxx-xx-xxxx."
},
"street1": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee street address (line 1)."
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee Municipality."
},
"region": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Two-letter state or territory abbreviation (e.g., ID)."
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"pattern": "^\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Postal/ZIP code in 5-digit or 5+4 format."
},
"single": {
"type": "boolean",
"description": "Withholding Status A - Single: Single with one or multiple jobs, or head of household."
},
"married": {
"type": "boolean",
"description": "Withholding Status B - Married: Married filing jointly with one job and spouse doesn't work, or qualifying surviving spouse."
},
"marriedWithholdAtSingleRate": {
"type": "boolean",
"description": "Withholding Status C - Married, but withhold at Single rate: Married filing jointly and both work, or married filing separately."
},
"exempt": {
"type": "boolean",
"description": "Exempt from withholding. When true, allowances are set to 99 and the TwApi.Services.Enrollment.API.Models.IdahoW4TaxForm2025Model.Allowances field must not be provided.\r\nMutually exclusive with TwApi.Services.Enrollment.API.Models.IdahoW4TaxForm2025Model.Allowances."
},
"allowances": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "Line 1: Total number of Idaho allowances claimed (0-99). Required when TwApi.Services.Enrollment.API.Models.IdahoW4TaxForm2025Model.Exempt is false; must be omitted (null) when TwApi.Services.Enrollment.API.Models.IdahoW4TaxForm2025Model.Exempt is true.",
"format": "int32",
"nullable": true
},
"additionalWithholdingAmount": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer",
"description": "Line 2: Additional amount to withhold from each paycheck (whole dollars). Null is treated as zero.",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": "Request model for Idaho W-4 Tax Form for the year 2025."
},
"TwApi.Services.Enrollment.API.Models.IllinoisILW4TaxForm2023Model": {
"required": [
"firstName",
"lastName",
"municipality",
"postalCode",
"region",
"socialSecurityNumber",
"street1"
],
"type": "object",
"properties": {
"firstName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee first name as it appears on their Social Security card."
},
"lastName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee last name as it appears on their Social Security card."
},
"socialSecurityNumber": {
"minLength": 1,
"pattern": "^\\d{3}-\\d{2}-\\d{4}$",
"type": "string",
"description": "Employee Social Security Number in the format xxx-xx-xxxx."
},
"street1": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee street address (line 1)."
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee Municipality."
},
"region": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Two-letter state or territory abbreviation (e.g., AZ)."
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"pattern": "^\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Postal/ZIP code in 5-digit or 5+4 format."
},
"boxExemptFromIllinoisIncomeTaxWithholding": {
"type": "boolean",
"description": "Exempt from Federal and Illinois income tax withholding. Check the box if you meet the condition"
},
"box1BasicAllowances": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "Number of basic allowances you are claiming. If you are claiming no allowances, enter 0.",
"format": "int32",
"nullable": true
},
"box2AdditionalAllowances": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "Number of additional allowances (other than spouse and dependents)",
"format": "int32",
"nullable": true
},
"box3AdditionalWithholdingAmount": {
"minimum": 0,
"type": "number",
"description": "Additional amount, if any, you want deducted each pay period.",
"format": "double",
"nullable": true
}
},
"additionalProperties": false,
"description": "Request model for Illinois IL-W-4 Tax Form for the year 2025."
},
"TwApi.Services.Enrollment.API.Models.IowaIAW4TaxForm2025Model": {
"required": [
"exempt",
"exemptMilitarySpouse",
"filingStatusHeadOfHousehold",
"filingStatusMarriedFilingJointly",
"filingStatusOther",
"filingStatusQualifyingSurvivingSpouse",
"firstName",
"governmentPersonalIdentifier",
"lastName",
"municipality",
"postalCode",
"region",
"street1"
],
"type": "object",
"properties": {
"firstName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee first name as it appears on their Social Security card."
},
"middleInitial": {
"maxLength": 1,
"minLength": 0,
"type": "string",
"description": "Employee middle initial.",
"nullable": true
},
"lastName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee last name as it appears on their Social Security card."
},
"governmentPersonalIdentifier": {
"minLength": 1,
"pattern": "^\\d{3}-\\d{2}-\\d{4}$",
"type": "string",
"description": "Employee Social Security Number in the format xxx-xx-xxxx."
},
"street1": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee home address (Number and Street or Rural Route)."
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee city or town."
},
"region": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Two-letter state or territory abbreviation (e.g., IA)."
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"pattern": "^\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Postal/ZIP code in 5-digit or 5+4 format."
},
"filingStatusOther": {
"type": "boolean",
"description": "Filing status: Other (includes taxpayers using the single filing status, married filing separately,\r\nor married taxpayers wanting to withhold as a taxpayer with a filing status of Single)."
},
"filingStatusHeadOfHousehold": {
"type": "boolean",
"description": "Filing status: Head of Household."
},
"filingStatusMarriedFilingJointly": {
"type": "boolean",
"description": "Filing status: Married filing jointly (includes qualifying surviving spouses)."
},
"filingStatusQualifyingSurvivingSpouse": {
"type": "boolean",
"description": "Filing status: Qualifying Surviving Spouse."
},
"spouseHasEarnedIncome": {
"type": "boolean",
"description": "Does your spouse also have earned income? Applicable only when filing as Married filing jointly.\r\nIf Yes, withholding calculation will be completed as if using filing status single.",
"nullable": true
},
"exempt": {
"type": "boolean",
"description": "Exempt from withholding: Employee does not expect to owe any Iowa income tax\r\nand had a right to a refund of all Iowa income tax withheld."
},
"exemptYearEffective": {
"pattern": "^\\d{4}$",
"type": "string",
"description": "The year effective for the exemption from withholding.",
"nullable": true
},
"exemptMilitarySpouse": {
"type": "boolean",
"description": "Exempt from Iowa income tax as a military spouse\r\nof 2009 or the Veterans Benefits and Transition Act of 2018 and the Veterans Auto and Education\r\nImprovement Act of 2022."
},
"militarySpouseStateOfDomicile": {
"maxLength": 2,
"minLength": 0,
"type": "string",
"description": "If claiming the military spouse exemption, enter the state of domicile or residence (2-letter abbreviation).",
"nullable": true
},
"line1PersonalAllowances": {
"minimum": 0,
"type": "number",
"description": "Line 1. Personal allowances ($40 per allowance for yourself, with additional amounts for age 65+, blindness, etc.).",
"format": "double",
"nullable": true
},
"line2DependentAllowances": {
"minimum": 0,
"type": "number",
"description": "Line 2. Allowances for dependents: $40 for each dependent you will claim on your Iowa income tax return.\r\nMust be divisible by 40.",
"format": "double",
"nullable": true
},
"line3ItemizedDeductions": {
"minimum": 0,
"type": "number",
"description": "Line 3. Allowances for itemized deductions. See instructions for calculation.",
"format": "double",
"nullable": true
},
"line4AdjustmentsToIncome": {
"minimum": 0,
"type": "number",
"description": "Line 4. Allowances for adjustments to income. Estimate allowable adjustments to income\r\n(IRA, Keogh, SEP, penalty on early withdrawal of savings, student loan interest).\r\nMultiply by 3.8% (.038), round to nearest whole dollar.",
"format": "double",
"nullable": true
},
"line5ChildDependentCareCredit": {
"minimum": 0,
"type": "number",
"description": "Line 5. Allowances for child and dependent care credit. See instructions for calculation.",
"format": "double",
"nullable": true
},
"line6PersonalExemptionCredit": {
"minimum": 0,
"type": "number",
"description": "Line 6. Personal exemption credit allowed for federal purposes. See instructions.",
"format": "double",
"nullable": true
},
"line7TotalAllowances": {
"minimum": 0,
"type": "number",
"description": "Line 7. Total Allowances: Add Lines 1 through 6 and enter total here.",
"format": "double",
"nullable": true
},
"line8AdditionalWithholding": {
"minimum": 0,
"type": "number",
"description": "Line 8. Additional amount, if any, you want deducted each pay period.",
"format": "double",
"nullable": true
}
},
"additionalProperties": false,
"description": "Request model for Iowa IA W-4 (Employee Withholding Allowance Certificate) for the 2025 form revision."
},
"TwApi.Services.Enrollment.API.Models.KansasK4TaxForm2024Model": {
"required": [
"firstName",
"governmentPersonalIdentifier",
"lastName",
"municipality",
"postalCode",
"region",
"street1"
],
"type": "object",
"properties": {
"firstName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee first name as it appears on their Social Security card."
},
"middleInitial": {
"maxLength": 1,
"minLength": 0,
"type": "string",
"description": "Employee middle initial as it appears on their Social Security card.",
"nullable": true
},
"lastName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee last name as it appears on their Social Security card."
},
"governmentPersonalIdentifier": {
"minLength": 1,
"pattern": "^\\d{3}-\\d{2}-\\d{4}$",
"type": "string",
"description": "Social Security Number in xxx-xx-xxxx format."
},
"street1": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee street address (line 1)."
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee municipality (city)."
},
"region": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Two-letter state or territory abbreviation (e.g., KS)."
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"pattern": "^\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Postal/ZIP code in 5-digit or 5+4 format."
},
"lineAAllowanceRateSingle": {
"type": "boolean",
"description": "Line A Allowance Rate: Single. Exactly one of Single/Joint must be selected when not exempt."
},
"lineAAllowanceRateJoint": {
"type": "boolean",
"description": "Line A Allowance Rate: Joint. Exactly one of Single/Joint must be selected when not exempt."
},
"lineBMarriedOrSingle": {
"maximum": 1,
"minimum": 0,
"type": "integer",
"description": "Line B: Enter 0 or 1.",
"format": "int32",
"nullable": true
},
"lineCMarriedOneJobSpouseDoesNotWork": {
"maximum": 1,
"minimum": 0,
"type": "integer",
"description": "Line C: Enter 0 or 1.",
"format": "int32",
"nullable": true
},
"lineDHeadOfHousehold": {
"maximum": 2,
"minimum": 0,
"type": "integer",
"description": "Line D: Enter 2 if filing Head of Household, else 0.",
"format": "int32",
"nullable": true
},
"lineEDependents": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "Line E: Number of dependents claimed on Kansas return.",
"format": "int32",
"nullable": true
},
"lineFTotalAllowances": {
"minimum": 0,
"type": "integer",
"description": "Line F: Total allowances (B + C + D + E).",
"format": "int32",
"nullable": true
},
"line5ExtraWithholdingAmount": {
"minimum": 0,
"type": "number",
"description": "Line 5: Optional extra Kansas tax to withhold each paycheck.",
"format": "double",
"nullable": true
},
"isExempt": {
"type": "boolean",
"description": "Exempt status (true if claiming exemption)."
},
"employeeSignatureDate": {
"type": "string",
"description": "Employee signature date. (optional)",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false,
"description": "Request model for Kansas K-4 (Rev. 7-24)"
},
"TwApi.Services.Enrollment.API.Models.KentuckyK4TaxForm2026Model": {
"required": [
"firstName",
"governmentPersonalIdentifier",
"lastName",
"middleInitial",
"municipality",
"postalCode",
"region",
"street1"
],
"type": "object",
"properties": {
"governmentPersonalIdentifier": {
"minLength": 1,
"pattern": "^\\d{3}-\\d{2}-\\d{4}$",
"type": "string",
"description": "Employee Social Security Number in the format xxx-xx-xxxx."
},
"firstName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee first name as it appears on their Social Security card."
},
"lastName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee last name as it appears on their Social Security card."
},
"middleInitial": {
"maxLength": 1,
"minLength": 0,
"type": "string",
"description": "Employee legal Middle Initial as it appears on their Social Security card."
},
"street1": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee street address (line 1)."
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee Municipality."
},
"region": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Two-letter state or territory abbreviation (e.g., AZ)."
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"pattern": "^\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Postal/ZIP code in 5-digit or 5+4 format."
},
"kentuckyTaxExempt": {
"type": "boolean",
"description": "Are you exempt from Kentucky state income tax withholding"
},
"fortCampbellExempt": {
"type": "boolean",
"description": "Are you exempt from Fort Campbell withholding"
},
"stateOfResidence": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Two-letter state or territory abbreviation (e.g., AZ).",
"nullable": true
},
"militarySpouse": {
"type": "boolean",
"description": "Are you a military spouse"
},
"workInKetuckyAndResideOutOfState": {
"type": "boolean",
"description": "Do you work in Kentucky and reside out of state"
},
"additionalWitholding": {
"type": "number",
"description": "Additional withholding amount",
"format": "double",
"nullable": true
}
},
"additionalProperties": false,
"description": "Kentucky K-4 (state withholding) – 2021 revision model."
},
"TwApi.Services.Enrollment.API.Models.LouisianaL4ETaxForm2025Model": {
"required": [
"exempt1NoTaxLiability",
"exempt2MilitarySpouseSCRA",
"firstName",
"governmentPersonalIdentifier",
"lastName",
"municipality",
"postalCode",
"region",
"street1",
"taxYear"
],
"type": "object",
"properties": {
"firstName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee first name as it appears on their Social Security card."
},
"middleInitial": {
"maxLength": 1,
"minLength": 0,
"type": "string",
"description": "Employee middle initial.",
"nullable": true
},
"lastName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee last name as it appears on their Social Security card."
},
"governmentPersonalIdentifier": {
"minLength": 1,
"pattern": "^\\d{3}-\\d{2}-\\d{4}$",
"type": "string",
"description": "Employee Social Security Number in the format xxx-xx-xxxx."
},
"street1": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee street address (line 1)."
},
"street2": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee street address (line 2).",
"nullable": true
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee city, village, or post office."
},
"region": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Two-letter state or territory abbreviation."
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"pattern": "^\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Postal/ZIP code in 5-digit or 5+4 format."
},
"exempt1NoTaxLiability": {
"type": "boolean",
"description": "Exempt 1: Employee incurred no Louisiana income-tax liability for the prior year\r\nand anticipates no liability for the current year."
},
"exempt2MilitarySpouseSCRA": {
"type": "boolean",
"description": "Exempt 2: Employee qualifies for exemption under the Servicemember Civil Relief Act,\r\nas amended by the Veterans Auto and Education Improvement Act of 2022."
},
"taxDomicileState": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Two-letter state abbreviation for the employee's tax domicile.\r\nRequired when TwApi.Services.Enrollment.API.Models.LouisianaL4ETaxForm2025Model.Exempt2MilitarySpouseSCRA is true.",
"nullable": true
},
"taxYear": {
"maximum": 2100,
"minimum": 2020,
"type": "integer",
"description": "The tax year for which the exemption applies.",
"format": "int32"
},
"employerName": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employer name.",
"nullable": true
},
"employerStreet1": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employer street address (line 1).",
"nullable": true
},
"employerMunicipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employer city.",
"nullable": true
},
"employerRegion": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Employer state or territory abbreviation.",
"nullable": true
},
"employerPostalCode": {
"maxLength": 10,
"minLength": 0,
"pattern": "^\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Employer postal/ZIP code in 5-digit or 5+4 format.",
"nullable": true
},
"employerWithholdingAccountNumber": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employer state withholding account number.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Request model for the Louisiana L-4E Certificate of Exemption from Withholding for the year 2025."
},
"TwApi.Services.Enrollment.API.Models.LouisianaL4TaxForm2026Model": {
"required": [
"dependents",
"filingStatus",
"firstName",
"governmentPersonalIdentifier",
"lastName",
"municipality",
"postalCode",
"region",
"street1"
],
"type": "object",
"properties": {
"firstName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee first name as it appears on their Social Security card."
},
"middleInitial": {
"maxLength": 1,
"minLength": 0,
"type": "string",
"description": "Employee middle initial.",
"nullable": true
},
"lastName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee last name as it appears on their Social Security card."
},
"governmentPersonalIdentifier": {
"minLength": 1,
"pattern": "^\\d{3}-\\d{2}-\\d{4}$",
"type": "string",
"description": "Employee Social Security Number in the format xxx-xx-xxxx."
},
"street1": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee home address (number and street or rural route)."
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee city."
},
"region": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Two-letter state or territory abbreviation (e.g., LA)."
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"pattern": "^\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Postal/ZIP code in 5-digit or 5+4 format."
},
"filingStatus": {
"maximum": 2,
"minimum": 0,
"type": "integer",
"description": "Line 3 / Block A filing status. Determines the standard deduction level:\r\n0 = No deduction (no standard deduction claimed),\r\n1 = Single or married filing separately,\r\n2 = Married filing jointly, qualifying surviving spouse, or head of household.",
"format": "int32"
},
"dependents": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "Number of dependent deductions claimed in Block A.",
"format": "int32"
},
"additionalWithholding": {
"type": "number",
"description": "Line 7. Any increase or decrease in the amount of tax to be withheld each pay period.\r\nDecreases should be indicated as a negative amount and cannot result in an amount less\r\nthan zero to be withheld each pay period.",
"format": "double",
"nullable": true
},
"employerName": {
"maxLength": 100,
"minLength": 0,
"type": "string",
"description": "Employer's name and address.",
"nullable": true
},
"employerWithholdingAccountNumber": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employer's state withholding account number.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Request model for Louisiana L-4 (Employee's Withholding Certificate) for the 1/26 form revision."
},
"TwApi.Services.Enrollment.API.Models.MaineW4METaxForm2025Model": {
"required": [
"firstName",
"governmentPersonalIdentifier",
"lastName",
"married",
"marriedButHigherSingleRate",
"municipality",
"postalCode",
"region",
"singleOrHeadOfHousehold",
"street1"
],
"type": "object",
"properties": {
"firstName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Type or print your first name"
},
"middleInitial": {
"maxLength": 1,
"minLength": 0,
"type": "string",
"description": "M.I.",
"nullable": true
},
"lastName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Last Name."
},
"governmentPersonalIdentifier": {
"minLength": 1,
"pattern": "^\\d{3}-\\d{2}-\\d{4}$",
"type": "string",
"description": "Your social security number."
},
"street1": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Home address (number and street)"
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "City or town"
},
"region": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "State"
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"pattern": "^\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Zip code"
},
"singleOrHeadOfHousehold": {
"type": "boolean",
"description": "Single or Head of Household"
},
"married": {
"type": "boolean",
"description": "Married"
},
"marriedButHigherSingleRate": {
"type": "boolean",
"description": "Married, but withholding at higher single rate"
},
"step4TotalAllowances": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "Total number of allowances you are claiming on the Personal Allowances Worksheet, line E below",
"format": "int32",
"nullable": true
},
"step5AdditionalWithholdingAmount": {
"minimum": 0,
"type": "number",
"description": "Additional amount, if any, you want withheld from your paycheck",
"format": "double",
"nullable": true
},
"step6AExempt": {
"type": "boolean",
"description": "You claimed an exemption from withholding for the tax year on your federal Form W-4"
},
"step6BNoWithholding": {
"type": "boolean",
"description": "You requested that no withholding be withheld for the tax year on your federal Form W-4P"
},
"step6CNoTaxLiability": {
"type": "boolean",
"description": "You are a resident employee with no Maine tax liability in prior and current years"
},
"step6DRetirementNoTaxLiability": {
"type": "boolean",
"description": "You are a recipient of periodic retirement payments with no tax liability in prior and current years"
},
"step6EMilitarySpouseResidencyReliefAct": {
"type": "boolean",
"description": "Your spouse is a member of the military assigned to a location in Maine and you qualify for exemption under\r\nthe Military Spouse’s Residency Relief Act.You must attach supporting documents. See instructions"
},
"step7EnrolledTribalMember": {
"type": "boolean",
"description": "Check this box if you are an enrolled tribal member residing on tribal land in Maine\r\nand you are claiming an exemption from Maine withholding on the wages, salaries, or\r\nother compensation derived from or connected with sources on tribal land in Maine\r\n(that is, wages, salaries, or other compensation for work performed in Maine on\r\ntribal land). See instructions for additional information."
}
},
"additionalProperties": false,
"description": "Request model for Maine state withholding Tax Form W-4ME for the year 2025."
},
"TwApi.Services.Enrollment.API.Models.MarylandMW507TaxForm2026Model": {
"required": [
"countyOfResidence",
"employeeSignatureDate",
"firstName",
"governmentPersonalIdentifier",
"isMarried",
"isMarriedWithholdAtSingleRate",
"isSingle",
"lastName",
"line1TotalExemptions",
"municipality",
"postalCode",
"region",
"street1"
],
"type": "object",
"properties": {
"firstName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee first name as it appears on their Social Security card."
},
"lastName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee last name as it appears on their Social Security card."
},
"governmentPersonalIdentifier": {
"minLength": 1,
"pattern": "^\\d{3}-\\d{2}-\\d{4}$",
"type": "string",
"description": "Employee Social Security Number in the format xxx-xx-xxxx."
},
"street1": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee street address (line 1)."
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee Municipality."
},
"region": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Two-letter state or territory abbreviation (e.g., MD)."
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"pattern": "^\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Postal/ZIP code in 5-digit or 5+4 format."
},
"countyOfResidence": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "County of residence. Nonresidents enter Maryland county (or Baltimore City) where you are employed.\r\nValid values: Allegany, Anne Arundel, Baltimore City, Baltimore County, Calvert, Caroline, Carroll,\r\nCecil, Charles, Dorchester, Frederick, Garrett, Harford, Howard, Kent, Montgomery,\r\nPrince George's, Queen Anne's, Somerset, St Mary's, Talbot, Washington, Wicomico, Worcester."
},
"isSingle": {
"type": "boolean",
"description": "Filing status: Single."
},
"isMarried": {
"type": "boolean",
"description": "Filing status: Married (surviving spouse or unmarried Head of Household) Rate."
},
"isMarriedWithholdAtSingleRate": {
"type": "boolean",
"description": "Filing status: Married, but withhold at Single rate."
},
"line1TotalExemptions": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "Line 1. Total number of exemptions you are claiming (not to exceed line f in Personal Exemption Worksheet).",
"format": "int32"
},
"line2AdditionalWithholding": {
"maximum": 2147483647,
"minimum": 0,
"type": "number",
"description": "Line 2. Additional withholding per pay period under agreement with employer.",
"format": "double",
"nullable": true
},
"line3a": {
"type": "boolean",
"description": "Line 3a. Last year I did not owe any Maryland income tax and had a right to a full refund of all income tax withheld."
},
"line3b": {
"type": "boolean",
"description": "Line 3b. This year I do not expect to owe any Maryland income tax and expect to have the right to a full refund of all income tax withheld."
},
"line3ExemptionYear": {
"maximum": 2099,
"minimum": 2000,
"type": "integer",
"description": "Line 3. Year applicable for exemption from withholding. Required when Line3Exempt is true.",
"format": "int32",
"nullable": true
},
"line3Exempt": {
"type": "boolean",
"description": "Line 3. True if claiming exemption from withholding because the employee does not expect to owe Maryland tax. Requires both Line3a and Line3b to be true."
},
"line4DomicileState": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Line 4. Two-letter state abbreviation for domicile state when claiming exemption from withholding. Must be DC, VA, or WV.",
"nullable": true
},
"line4Exempt": {
"type": "boolean",
"description": "Line 4. True if claiming exemption from withholding because domiciled in DC, VA, or WV and not maintaining a place of abode in Maryland."
},
"line5Exempt": {
"type": "boolean",
"description": "Line 5. True if claiming exemption from Maryland state withholding because domiciled in the Commonwealth of Pennsylvania\r\nand not maintaining a place of abode in Maryland."
},
"line6Exempt": {
"type": "boolean",
"description": "Line 6. True if claiming exemption from Maryland local tax because the employee lives in a local Pennsylvania\r\njurisdiction within York or Adams counties."
},
"line7Exempt": {
"type": "boolean",
"description": "Line 7. True if claiming exemption from Maryland local tax because the employee lives in a local Pennsylvania\r\njurisdiction that does not impose an earnings or income tax on Maryland residents."
},
"line8StateOfLegalResidence": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Line 8. Two-letter state abbreviation for the legal state of residence under the Servicemembers Civil Relief Act\r\nas amended by the Military Spouses Residency Relief Act. Required when Line8Exempt is true.",
"nullable": true
},
"line8Exempt": {
"type": "boolean",
"description": "Line 8. True if claiming exemption from Maryland withholding under the Servicemembers Civil Relief Act\r\nas amended by the Military Spouses Residency Relief Act."
},
"employeeSignatureDate": {
"type": "string",
"description": "Employee signature date.",
"format": "date-time"
},
"employerNameAndAddress": {
"maxLength": 200,
"minLength": 0,
"type": "string",
"description": "Employer's name and address including ZIP code. For employer use only.",
"nullable": true
},
"federalEmployerIdentificationNumber": {
"maxLength": 20,
"minLength": 0,
"type": "string",
"description": "Federal Employer Identification Number. For employer use only.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Request model for Maryland MW507 Tax Form for the year 2026."
},
"TwApi.Services.Enrollment.API.Models.MassachusettsM4TaxForm2024Model": {
"required": [
"dependents",
"firstName",
"governmentPersonalIdentifier",
"lastName",
"municipality",
"personalExemptions",
"postalCode",
"region",
"spouseExemptions",
"street1",
"totalExemptions"
],
"type": "object",
"properties": {
"firstName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee first name as it appears on their Social Security card."
},
"lastName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Last Name as it appears on their Social Security card."
},
"governmentPersonalIdentifier": {
"minLength": 1,
"pattern": "^\\d{3}-\\d{2}-\\d{4}$",
"type": "string",
"description": "Employee Social Security Number in the format xxx-xx-xxxx."
},
"street1": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee street address (line 1)"
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee Municipality (city/town)."
},
"region": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Two-letter state or territory abbreviation (e.g., MA)."
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"pattern": "^\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Postal/ZIP code in 5-digit or 5+4 format."
},
"personalExemptions": {
"type": "integer",
"description": "Personal Exemptions (Line 1):\r\nYour personal exemption. Enter \"1\" or, if you are age 65 or over or will be before next year, enter \"2\"",
"format": "int32"
},
"spouseExemptions": {
"type": "integer",
"description": "Spouse Exemptions (Line 2):\r\nIf married and if exemption for spouse is allowed, enter \"4\" in line 2. \r\nIf your spouse is age 65 or over or will be before next year and if otherwise qualified, enter \"5\".",
"format": "int32"
},
"dependents": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "Number of dependents (Line 3):\r\nEnter the number of qualified dependents.",
"format": "int32"
},
"totalExemptions": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "Total Exemptions (Line 4):\r\nTotal number of withholding exemptions. Add lines 1 through 3.",
"format": "int32"
},
"additionalWithholding": {
"minimum": 0,
"type": "number",
"description": "Additional withholding (Line 5):\r\nAdditional withholding per pay period under agreement with your employer.",
"format": "double",
"nullable": true
},
"selectionA": {
"type": "boolean",
"description": "Selection A: Fill in you will file as head of household"
},
"selectionB": {
"type": "boolean",
"description": "Selection B: Fill in you are blind"
},
"selectionC": {
"type": "boolean",
"description": "Selection C: Fill in your spouse if blind and not subject to withholding"
},
"selectionD": {
"type": "boolean",
"description": "Selection D: Fill in you are a full-time student engaged in seasonal, part-time, or temporary employment whose estimated annual income will not exceed $8,000."
}
},
"additionalProperties": false,
"description": "Request model for Massachusetts state withholding Tax Form M-4 for the year 2024."
},
"TwApi.Services.Enrollment.API.Models.MichiganMIW4TaxForm2020Model": {
"required": [
"dateOfBirth",
"dependentExemptions",
"firstName",
"governmentPersonalIdentifier",
"isNewEmployee",
"isNotNewEmployee",
"lastName",
"municipality",
"postalCode",
"region",
"street1"
],
"type": "object",
"properties": {
"governmentPersonalIdentifier": {
"minLength": 1,
"pattern": "^\\d{3}-\\d{2}-\\d{4}$",
"type": "string",
"description": "Employee Social Security Number in the format xxx-xx-xxxx."
},
"dateOfBirth": {
"type": "string",
"description": "Employee date of birth.",
"format": "date"
},
"firstName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee first name as it appears on their Social Security card."
},
"lastName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee last name as it appears on their Social Security card."
},
"employeeDriversLicenseNumber": {
"type": "string",
"description": "Employee Drivers License Number as it appears on the Drivers License",
"nullable": true
},
"street1": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee street address (line 1)."
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee Municipality."
},
"region": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Two-letter state or territory abbreviation (e.g., AZ)."
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"pattern": "^\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Postal/ZIP code in 5-digit or 5+4 format."
},
"isNewEmployee": {
"type": "boolean",
"description": "If you are a new employee"
},
"isNotNewEmployee": {
"type": "boolean",
"description": "If you are not a new employee"
},
"newEmployeeHireDate": {
"type": "string",
"description": "Date you were hired if you are a new employee",
"format": "date",
"nullable": true
},
"dependentExemptions": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "Number of Dependents and Personal exemptions",
"format": "int32"
},
"additionalDeductions": {
"type": "integer",
"description": "Amount you want want deducted from each pay",
"format": "int32",
"nullable": true
},
"incomeTaxLiabilityExemption": {
"type": "boolean",
"description": "Income Tax Liability is not expected this year"
},
"withholdingExemption": {
"type": "boolean",
"description": "Wages are exempt from withholding"
},
"withholdingExemptionExplaination": {
"type": "string",
"description": "Explaination for why you are exempt from withholding",
"nullable": true
},
"permanentHomeExemption": {
"type": "boolean",
"description": "Permanent Home is located in a Renaissance Zone"
},
"permanentHomeExemptionRenaissanceZone": {
"type": "string",
"description": "Renaissance Zone your home is located in",
"nullable": true
}
},
"additionalProperties": false,
"description": "TODO"
},
"TwApi.Services.Enrollment.API.Models.MinnesotaW4MN2026Model": {
"required": [
"daytimePhoneNumber",
"firstName",
"governmentPersonalIdentifier",
"lastName",
"married",
"marriedHigherWithholdingRate",
"municipality",
"postalCode",
"region",
"section1",
"section2",
"singleLegallySeparatedOrNonResidentSpouse",
"street1"
],
"type": "object",
"properties": {
"firstName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee first name as it appears on their Social Security card."
},
"lastName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee last name as it appears on their Social Security card."
},
"governmentPersonalIdentifier": {
"minLength": 1,
"pattern": "^\\d{3}-\\d{2}-\\d{4}$",
"type": "string",
"description": "Employee Social Security Number in the format xxx-xx-xxxx."
},
"street1": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee street address (line 1)."
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee Municipality (city)."
},
"region": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Two-letter state or territory abbreviation (e.g., MN)."
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"pattern": "^\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Postal/ZIP code in 5-digit or 5+4 format."
},
"singleLegallySeparatedOrNonResidentSpouse": {
"type": "boolean",
"description": "Filing status: check if single, legally separated, or married with a nonresident spouse."
},
"married": {
"type": "boolean",
"description": "Filing status: check if married."
},
"marriedHigherWithholdingRate": {
"type": "boolean",
"description": "Filing status: check if married but electing the higher withholding rate."
},
"section1": {
"type": "boolean",
"description": "Indicates Section 1 (Determining Minnesota Allowances) is being used."
},
"section1A": {
"maximum": 1,
"minimum": 0,
"type": "integer",
"description": "A. Enter \"1\" if no one else can claim you as a dependent.",
"format": "int32",
"nullable": true
},
"section1B": {
"maximum": 1,
"minimum": 0,
"type": "integer",
"description": "B. Enter \"1\" if any of the following apply:\r\n• You are single and have only one job\r\n• You are married, have only one job, and your spouse does not work\r\n• Your wages from a second job or your spouse’s wages are $1500 or less",
"format": "int32",
"nullable": true
},
"section1C": {
"maximum": 1,
"minimum": 0,
"type": "integer",
"description": "C. Enter \"1\" if you are married, or enter \"0\" if you are married and have either a working spouse or more than one job.\r\n(Entering \"0\" may help you avoid having too little tax withheld.)",
"format": "int32",
"nullable": true
},
"section1D": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "D. Enter the number of dependents you will claim on your tax return.",
"format": "int32",
"nullable": true
},
"section1E": {
"maximum": 1,
"minimum": 0,
"type": "integer",
"description": "E. Enter \"1\" if you will use the filing status Head of Household.",
"format": "int32",
"nullable": true
},
"section1F": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "F. Add steps A through E. If you plan to itemize deductions on your 2026 Minnesota income tax return,\r\nyou may also complete the Itemized Deductions and Additional Income Worksheet.",
"format": "int32",
"nullable": true
},
"section1Allowances": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "Minnesota Allowances. Enter Step F from Section 1 above or Step 10 of the Itemized Deductions Worksheet.",
"format": "int32",
"nullable": true
},
"section1AdditionalWithholding": {
"maximum": 2147483647,
"minimum": 0,
"type": "number",
"description": "Additional Minnesota withholding you want deducted for each pay period.",
"format": "double",
"nullable": true
},
"section2": {
"type": "boolean",
"description": "Indicates Section 2 (Exemption From Minnesota Withholding) is being used."
},
"section2A": {
"type": "boolean",
"description": "I meet the requirements and claim exempt from both federal and Minnesota income tax withholding.",
"nullable": true
},
"section2B": {
"type": "boolean",
"description": "Even though I did not claim exempt from federal withholding, I claim exempt from Minnesota withholding, because:\r\n• I had no Minnesota income tax liability last year.\r\n• I received a refund of all Minnesota income tax withheld.\r\n• I expect to have no Minnesota income tax liability this year.",
"nullable": true
},
"section2C": {
"type": "boolean",
"description": "All of these apply:\r\n• My spouse is a military service member assigned to a military location in Minnesota.\r\n• My domicile (legal residence) is in another state.\r\n• I am in Minnesota solely to be with my spouse. My state of domicile is (two-letter code below).",
"nullable": true
},
"section2CStateOfDomicile": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Two-letter state code for domicile when claiming the military spouse exemption in Section 2C.",
"nullable": true
},
"section2D": {
"type": "boolean",
"description": "I am an American Indian that resides and works on a reservation for which I am enrolled.",
"nullable": true
},
"section2DReservationName": {
"maxLength": 100,
"minLength": 0,
"type": "string",
"description": "Name of the reservation (when Section 2D applies).",
"nullable": true
},
"section2DCDIBNumber": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Certificate of Degree of Indian Blood (CDIB)/Enrollment number (when Section 2D applies).",
"nullable": true
},
"section2E": {
"type": "boolean",
"description": "I am a member of the Minnesota National Guard or an active-duty U.S. military member and claim exempt\r\nfrom Minnesota withholding on my military pay.",
"nullable": true
},
"section2F": {
"type": "boolean",
"description": "I receive a military pension or other military retirement pay as calculated under U.S. Code, title 10,\r\nsections 1401 through 1414, 1447 through 1455, and 12733, and I claim exempt from Minnesota withholding on this retirement pay.",
"nullable": true
},
"daytimePhoneNumber": {
"minLength": 1,
"pattern": "^\\d{10}$",
"type": "string",
"description": "Daytime contact phone number. 10 digits, numbers only."
}
},
"additionalProperties": false,
"description": "Request model for Minnesota W-4MN Tax Form for the year 2026."
},
"TwApi.Services.Enrollment.API.Models.Mississippi89350TaxForm2025Model": {
"required": [
"firstName",
"governmentPersonalIdentifier",
"lastName",
"municipality",
"postalCode",
"region",
"street1"
],
"type": "object",
"properties": {
"firstName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee first name."
},
"middleInitial": {
"maxLength": 1,
"minLength": 0,
"type": "string",
"description": "Employee middle initial.",
"nullable": true
},
"lastName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee last name."
},
"governmentPersonalIdentifier": {
"minLength": 1,
"pattern": "^\\d{3}-\\d{2}-\\d{4}$",
"type": "string",
"description": "Employee Social Security Number in the format xxx-xx-xxxx."
},
"street1": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee street address (line 1)."
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee city or town."
},
"region": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Two-letter state or territory abbreviation (e.g., MS)."
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"pattern": "^\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Postal/ZIP code in 5-digit or 5+4 format."
},
"maritalStatusSingle": {
"type": "boolean",
"description": "Line 1: Single – $6,000 personal exemption."
},
"maritalStatusSpouseNotEmployed": {
"type": "boolean",
"description": "Line 2(a): Married, spouse NOT employed – $12,000 exemption."
},
"maritalStatusSpouseEmployed": {
"type": "boolean",
"description": "Line 2(b): Married, spouse IS employed – partial $12,000 exemption claimed in multiples of $500."
},
"maritalStatusSpouseEmployedAmount": {
"maximum": 12000,
"minimum": 0,
"type": "number",
"description": "Line 2(b): Amount claimed under spouse employed exemption, in multiples of $500 up to $12,000.\r\nDefaults to $12,000 if MaritalStatusSpouseEmployed is true and no amount is provided.",
"format": "double",
"nullable": true
},
"headOfFamily": {
"type": "boolean",
"description": "Line 3: Head of Family – $9,500 exemption."
},
"dependents": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "Line 4: Number of dependents claimed (each worth $1,500).",
"format": "int32",
"nullable": true
},
"ageExemption": {
"maximum": 4,
"minimum": 0,
"type": "integer",
"description": "Line 5: Age exemption (65 or older). 0 = None, 1 = Husband, 2 = Wife, 3 = Both, 4 = Single.",
"format": "int32"
},
"blindExemption": {
"maximum": 4,
"minimum": 0,
"type": "integer",
"description": "Line 5: Blind exemption. 0 = None, 1 = Husband, 2 = Wife, 3 = Both, 4 = Single.",
"format": "int32"
},
"additionalWithholdingAmount": {
"minimum": 0,
"type": "number",
"description": "Line 7: Additional dollar amount of withholding per pay period if agreed to by employer.",
"format": "double",
"nullable": true
},
"militaryExemption": {
"type": "boolean",
"description": "Line 8: Employee qualifies for exemption under the Service Member Civil Relief Act\r\nas amended by the Military Spouses Residency Relief Act. Write \"Exempt\" on Line 8.\r\nMust attach DD-2058 and Military Spouse ID Card."
}
},
"additionalProperties": false,
"description": "Request model for Mississippi state withholding Tax Form 89-350 for the year 2025."
},
"TwApi.Services.Enrollment.API.Models.MissouriMOW4TaxForm2024Model": {
"required": [
"firstName",
"governmentPersonalIdentifier",
"isActiveDutyExempt",
"isExempt",
"isHeadOfHousehold",
"isMarriedSpouseDoesNotWork",
"isServiceMemberExempt",
"isSingleOrMariedFilingSeparately",
"lastName",
"municipality",
"postalCode",
"region",
"street1"
],
"type": "object",
"properties": {
"firstName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee first name as it appears on their Social Security card."
},
"middleIntial": {
"maxLength": 1,
"minLength": 0,
"type": "string",
"description": "Employee middle initial as it appears on their Social Security card.",
"nullable": true
},
"lastName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee Last name as it appears on their Social Security card."
},
"governmentPersonalIdentifier": {
"minLength": 1,
"pattern": "^\\d{3}-\\d{2}-\\d{4}$",
"type": "string",
"description": "Employee Social Security Number in the format xxx-xx-xxxx."
},
"street1": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee street address (line 1)."
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee municipality(city)."
},
"region": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Two-letter state or territory abbreviation (e.g., MO)."
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"pattern": "^\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Postal/ZIP code in 5-digit or 5+4 format."
},
"isSingleOrMariedFilingSeparately": {
"type": "boolean",
"description": "Filing status: Single or Married Spouse Works or Married Filing Separate."
},
"isMarriedSpouseDoesNotWork": {
"type": "boolean",
"description": "Filing status: Married (Spouse does not work)"
},
"isHeadOfHousehold": {
"type": "boolean",
"description": "Filing status: Head of household."
},
"additionalWithholdingAmount": {
"minimum": 0,
"type": "number",
"description": "Additional amount, if any, you want deducted each pay period.",
"format": "double",
"nullable": true
},
"reducedWithholdingAmount": {
"minimum": 0,
"type": "number",
"description": "Reduced amount, if any, you want witheld each pay period.",
"format": "double",
"nullable": true
},
"isExempt": {
"type": "boolean",
"description": "Regular Exemption Status based on refunds that were withheld last year."
},
"isServiceMemberExempt": {
"type": "boolean",
"description": "Servicemember exemption base on the Servicemember Civil Relief Act."
},
"isActiveDutyExempt": {
"type": "boolean",
"description": "Active Duty Military Exemption based on being an active duty component."
},
"exemptStatus": {
"type": "string",
"description": "Must be filled out to Equal \"EXEMPT\" if any exemption status was selected.",
"nullable": true
},
"employeeSignatureDate": {
"type": "string",
"description": "Date in which the form is being signed.",
"format": "date",
"nullable": true
},
"employerBusinessName": {
"type": "string",
"description": "Employer Business Name as it appears on MO-W4 Form.",
"nullable": true
},
"employerBusinessAddress": {
"type": "string",
"description": "Employer Business Address as it appears on MO-W4 Form.",
"nullable": true
},
"employerBusinessMunicipality": {
"type": "string",
"description": "Employer Business Municipality (city) as it appears on MO-W4 Form.",
"nullable": true
},
"employerBusinessRegion": {
"type": "string",
"description": "Employer Business Region (state) as it appears on MO-W4 Form.",
"nullable": true
},
"employerBusinessPostalCode": {
"type": "string",
"description": "Employer Business Postal Code as it appears on MO-W4 Form.",
"nullable": true
},
"employeeStartDate": {
"type": "string",
"description": "The Date in which the Employee started the job the form is based on.",
"format": "date",
"nullable": true
},
"employerFederalIdentificationNumber": {
"type": "string",
"description": "Employer Federal Identification Number as it appears on MO-W4 Form.",
"nullable": true
},
"missouriTaxIdentificationNumber": {
"type": "string",
"description": "Missouri Tax Identification Number.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Request model for Missouri MO-W-4 Tax Form for the year 2024."
},
"TwApi.Services.Enrollment.API.Models.MontanaMW4TaxForm2025Model": {
"required": [
"exemptMilitarySpouse",
"exemptNationalGuard",
"exemptNorthDakotaResident",
"exemptRegisteredTribe",
"firstName",
"governmentPersonalIdentifier",
"headOfHousehold",
"lastName",
"marriedBothSpousesWorking",
"marriedFilingJointly",
"municipality",
"postalCode",
"region",
"singleFilingSeparately",
"street1"
],
"type": "object",
"properties": {
"firstName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee first name as it appears on their Social Security card."
},
"middleInitial": {
"maxLength": 1,
"minLength": 0,
"type": "string",
"description": "Employee middle initial.",
"nullable": true
},
"lastName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee last name as it appears on their Social Security card."
},
"governmentPersonalIdentifier": {
"minLength": 1,
"pattern": "^\\d{3}-\\d{2}-\\d{4}$",
"type": "string",
"description": "Employee Social Security Number in the format xxx-xx-xxxx."
},
"street1": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee physical address (line 1)."
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee city."
},
"region": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Two-letter state or territory abbreviation (e.g., MT)."
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"pattern": "^\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Postal/ZIP code in 5-digit or 5+4 format."
},
"singleFilingSeparately": {
"type": "boolean",
"description": "Line 1a. Filing status: Single filing separately (if you have multiple jobs, complete the Multiple Jobs Worksheet)."
},
"marriedFilingJointly": {
"type": "boolean",
"description": "Line 1b. Filing status: Married filing jointly or qualifying surviving spouse."
},
"headOfHousehold": {
"type": "boolean",
"description": "Line 1c. Filing status: Head of household."
},
"marriedBothSpousesWorking": {
"type": "boolean",
"description": "Line 2. Married Filing Jointly with Both Spouses Working.\r\nMark this if you are married and you and your spouse are both working and earn similar incomes.\r\nOnly applicable when MarriedFilingJointly (Line 1b) is true."
},
"extraWithholding": {
"minimum": 0,
"type": "number",
"description": "Line 3. Extra withholding. Enter any additional tax you want withheld from your wages each pay period.",
"format": "double",
"nullable": true
},
"specifiedWithholding": {
"minimum": 0,
"type": "number",
"description": "Line 4. Specified withholding. Enter the amount you want to withhold from retirement distributions\r\nor other payments. If you are an employee and enter an amount on this line, DO NOT complete lines 1, 2, or 3.",
"format": "double",
"nullable": true
},
"exemptRegisteredTribe": {
"type": "boolean",
"description": "Line 5a. Exempt because you are an enrolled member of a registered tribe, live on the reservation of that tribe,\r\nand earn wages from work performed on that reservation."
},
"exemptNationalGuard": {
"type": "boolean",
"description": "Line 5b. Exempt because you are a member of the Reserve or National Guard and your compensation is\r\nearned under U.S.C. Title 10."
},
"exemptNorthDakotaResident": {
"type": "boolean",
"description": "Line 5c. Exempt because you are a North Dakota resident."
},
"exemptMilitarySpouse": {
"type": "boolean",
"description": "Line 5d. Exempt because you are a resident of another state living in Montana solely to be with your spouse,\r\nwho is a resident of the same state and a member of the U.S. armed forces assigned to a military location in Montana."
}
},
"additionalProperties": false,
"description": "Request model for Montana MW-4 (Employee's Withholding and Exemption Certificate) for the 2025 form revision."
},
"TwApi.Services.Enrollment.API.Models.NebraskaW4NTaxForm2022Model": {
"required": [
"firstName",
"governmentPersonalIdentifier",
"lastName",
"married",
"municipality",
"postalCode",
"region",
"single",
"street1"
],
"type": "object",
"properties": {
"firstName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee first name as it appears on their Social Security card."
},
"middleInitial": {
"maxLength": 1,
"minLength": 0,
"type": "string",
"description": "Employee middle initial as it appears on their Social Security card.",
"nullable": true
},
"lastName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee last name as it appears on their Social Security card."
},
"governmentPersonalIdentifier": {
"minLength": 1,
"pattern": "^\\d{3}-\\d{2}-\\d{4}$",
"type": "string",
"description": "Social Security Number in xxx-xx-xxxx format."
},
"street1": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee street address (line 1)."
},
"street2": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee street address (line 2).",
"nullable": true
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee municipality (city)."
},
"region": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Two-letter state or territory abbreviation (e.g., NE)."
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"pattern": "^\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Postal/ZIP code in 5-digit or 5+4 format."
},
"single": {
"type": "boolean",
"description": "Filing status: Single (also Married Filing Separately, Nonresident Alien Spouse, Head of Household).\r\nMutually exclusive with TwApi.Services.Enrollment.API.Models.NebraskaW4NTaxForm2022Model.Married."
},
"married": {
"type": "boolean",
"description": "Filing status: Married Filing Jointly or Qualifying Widow(er).\r\nMutually exclusive with TwApi.Services.Enrollment.API.Models.NebraskaW4NTaxForm2022Model.Single."
},
"line1TotalAllowances": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "Line 1: Total number of allowances you are claiming (from line 4f on the worksheet).",
"format": "int32",
"nullable": true
},
"line2AdditionalWithholding": {
"minimum": 0,
"type": "number",
"description": "Line 2: Additional amount, if any, you want withheld from each check for Nebraska income tax.",
"format": "double",
"nullable": true
},
"isExempt": {
"type": "boolean",
"description": "Line 3: I claim exemption from withholding of Nebraska income tax."
},
"employeeSignatureDate": {
"type": "string",
"description": "Employee signature date. (optional)",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false,
"description": "Request model for Nebraska W-4N (Rev. 1-2022)"
},
"TwApi.Services.Enrollment.API.Models.NewJerseyNJW4TaxForm2021Model": {
"required": [
"filingStatus",
"firstName",
"governmentPersonalIdentifier",
"lastName",
"municipality",
"postalCode",
"region",
"street1"
],
"type": "object",
"properties": {
"firstName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee first name as it appears on their Social Security card."
},
"middleInitial": {
"maxLength": 1,
"minLength": 0,
"type": "string",
"description": "Employee middle initial as it appears on their Social Security card.",
"nullable": true
},
"lastName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee last name as it appears on their Social Security card."
},
"governmentPersonalIdentifier": {
"minLength": 1,
"pattern": "^\\d{3}-\\d{2}-\\d{4}$",
"type": "string",
"description": "Social Security Number in xxx-xx-xxxx format."
},
"street1": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee street address (line 1)."
},
"street2": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee street address (line 2).",
"nullable": true
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee municipality (city)."
},
"region": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Two-letter state or territory abbreviation (e.g., NJ)."
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"pattern": "^\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Postal/ZIP code in 5-digit or 5+4 format."
},
"filingStatus": {
"maximum": 5,
"minimum": 1,
"type": "integer",
"description": "Line 2: Filing Status.\r\n1 = Single\r\n2 = Married/Civil Union Couple Joint\r\n3 = Married/Civil Union Partner Separate\r\n4 = Head of Household\r\n5 = Qualifying Widow(er)/Surviving Civil Union Partner",
"format": "int32"
},
"line3WageChartLetter": {
"pattern": "^[A-Ea-e]$",
"type": "string",
"description": "Line 3: If you have chosen to use the chart from instruction A, enter the appropriate letter here (A, B, C, D, E).",
"nullable": true
},
"line4TotalAllowances": {
"minimum": 0,
"type": "integer",
"description": "Line 4: Total number of allowances you are claiming.",
"format": "int32",
"nullable": true
},
"line5AdditionalWithholding": {
"minimum": 0,
"type": "number",
"description": "Line 5: Additional amount you want deducted from each pay.",
"format": "double",
"nullable": true
},
"isExempt": {
"type": "boolean",
"description": "Line 6: I claim exemption from withholding of NJ Gross Income Tax."
},
"employeeSignatureDate": {
"type": "string",
"description": "Employee signature date. (optional)",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false,
"description": "Request model for New Jersey NJ-W4 (Rev. 1-21)"
},
"TwApi.Services.Enrollment.API.Models.NewYorkIT2104ETaxForm2026Model": {
"required": [
"firstName",
"governmentPersonalIdentifier",
"lastName",
"married",
"municipality",
"postalCode",
"qualifyingSurvivingSpouseOrHeadOfHousehold",
"region",
"single",
"street1"
],
"type": "object",
"properties": {
"firstName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee first name as it appears on their Social Security card."
},
"middleInitial": {
"maxLength": 1,
"minLength": 0,
"type": "string",
"description": "Employee middle initial.",
"nullable": true
},
"lastName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee last name as it appears on their Social Security card."
},
"governmentPersonalIdentifier": {
"minLength": 1,
"pattern": "^\\d{3}-\\d{2}-\\d{4}$",
"type": "string",
"description": "Employee Social Security Number in the format xxx-xx-xxxx."
},
"street1": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee street address (line 1)."
},
"street2": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee street address (line 2).",
"nullable": true
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee city, village, or post office."
},
"region": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Two-letter state or territory abbreviation."
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"pattern": "^\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Postal/ZIP code in 5-digit or 5+4 format."
},
"single": {
"type": "boolean",
"description": "Filing status A: Single."
},
"married": {
"type": "boolean",
"description": "Filing status B: Married."
},
"qualifyingSurvivingSpouseOrHeadOfHousehold": {
"type": "boolean",
"description": "Filing status C: Qualifying surviving spouse or head of household with qualifying person."
},
"isFullTimeStudent": {
"type": "boolean",
"description": "Indicates the employee is a full-time student (Group A qualification)."
},
"isMilitarySpouseExemptUnderSCRA": {
"type": "boolean",
"description": "Indicates the employee is a military spouse exempt under the SCRA (Group B qualification)."
},
"employerName": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employer name and address.",
"nullable": true
},
"employerStreet1": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employer street address (line 1).",
"nullable": true
},
"employerMunicipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employer city.",
"nullable": true
},
"employerRegion": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Employer state or territory abbreviation.",
"nullable": true
},
"employerPostalCode": {
"maxLength": 10,
"minLength": 0,
"pattern": "^\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Employer postal/ZIP code in 5-digit or 5+4 format.",
"nullable": true
},
"employerIdentificationNumber": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employer identification number.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Request model for the New York IT-2104-E Certificate of Exemption from Withholding for the year 2026."
},
"TwApi.Services.Enrollment.API.Models.NewYorkIT2104TaxForm2026Model": {
"required": [
"firstName",
"governmentPersonalIdentifier",
"lastName",
"married",
"marriedButWithholdAtHigherSingleRate",
"municipality",
"postalCode",
"region",
"singleOrHeadOfHousehold",
"street1"
],
"type": "object",
"properties": {
"firstName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee first name as it appears on their Social Security card."
},
"middleInitial": {
"maxLength": 1,
"minLength": 0,
"type": "string",
"description": "Employee middle initial.",
"nullable": true
},
"lastName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee last name as it appears on their Social Security card."
},
"governmentPersonalIdentifier": {
"minLength": 1,
"pattern": "^\\d{3}-\\d{2}-\\d{4}$",
"type": "string",
"description": "Employee Social Security Number in the format xxx-xx-xxxx."
},
"street1": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee street address (line 1)."
},
"street2": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee street address (line 2).",
"nullable": true
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee city, village, or post office."
},
"region": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Two-letter state or territory abbreviation."
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"pattern": "^\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Postal/ZIP code in 5-digit or 5+4 format."
},
"singleOrHeadOfHousehold": {
"type": "boolean",
"description": "Filing status: single or head of household."
},
"married": {
"type": "boolean",
"description": "Filing status: married."
},
"marriedButWithholdAtHigherSingleRate": {
"type": "boolean",
"description": "Filing status: married, but withhold at higher single rate."
},
"newYorkCityResident": {
"type": "boolean",
"description": "Indicates the employee is a resident of New York City."
},
"newYorkCityNonResident": {
"type": "boolean",
"description": "Indicates the employee is not a resident of New York City."
},
"yonkersResident": {
"type": "boolean",
"description": "Indicates the employee is a resident of Yonkers."
},
"yonkersNonResident": {
"type": "boolean",
"description": "Indicates the employee is not a resident of Yonkers."
},
"line1TotalAllowancesNYSOrYonkers": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "Line 1. Total number of allowances for New York State or Yonkers.",
"format": "int32",
"nullable": true
},
"line2TotalAllowancesNYC": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "Line 2. Total number of allowances for New York City.",
"format": "int32",
"nullable": true
},
"line3NewYorkStateAdditionalWithholdingAmount": {
"minimum": 0,
"type": "number",
"description": "Line 3. Additional amount to withhold for New York State each pay period.",
"format": "double",
"nullable": true
},
"line4NewYorkCityAdditionalWithholdingAmount": {
"minimum": 0,
"type": "number",
"description": "Line 4. Additional amount to withhold for New York City each pay period.",
"format": "double",
"nullable": true
},
"line5YonkersAdditionalWithholdingAmount": {
"minimum": 0,
"type": "number",
"description": "Line 5. Additional amount to withhold for Yonkers each pay period.",
"format": "double",
"nullable": true
},
"employerName": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employer name.",
"nullable": true
},
"employerStreet1": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employer street address (line 1).",
"nullable": true
},
"employerMunicipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employer city.",
"nullable": true
},
"employerRegion": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Employer state or territory abbreviation.",
"nullable": true
},
"employerPostalCode": {
"maxLength": 10,
"minLength": 0,
"pattern": "^\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Employer postal/ZIP code in 5-digit or 5+4 format.",
"nullable": true
},
"employerIdentificationNumber": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employer identification number.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Request model for the New York IT-2104 withholding allowance certificate for the year 2026."
},
"TwApi.Services.Enrollment.API.Models.NorthCarolinaNC4TaxForm2025Model": {
"required": [
"firstName",
"governmentPersonalIdentifier",
"headOfHousehold",
"lastName",
"marriedFilingJointlyOrSurvivingSpouse",
"municipality",
"postalCode",
"region",
"singleOrMarriedFilingSeparately",
"street1",
"totalAllowances"
],
"type": "object",
"properties": {
"firstName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee first name as it appears on their Social Security card."
},
"lastName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee last name as it appears on their Social Security card."
},
"governmentPersonalIdentifier": {
"minLength": 1,
"pattern": "^\\d{3}-\\d{2}-\\d{4}$",
"type": "string",
"description": "Employee Social Security Number in the format xxx-xx-xxxx."
},
"street1": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee street address (line 1)."
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee Municipality."
},
"region": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Two-letter state or territory abbreviation (e.g., NC)."
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"pattern": "^\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Postal/ZIP code in 5-digit or 5+4 format."
},
"singleOrMarriedFilingSeparately": {
"type": "boolean",
"description": "Filing status: Single or Married Filing Separately. Exactly one filing status must be true."
},
"headOfHousehold": {
"type": "boolean",
"description": "Filing status: Head of Household."
},
"marriedFilingJointlyOrSurvivingSpouse": {
"type": "boolean",
"description": "Filing status: Married Filing Jointly or Surviving Spouse."
},
"totalAllowances": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "Total number of allowances (required)",
"format": "int32"
},
"additionalWithholding": {
"minimum": 0,
"type": "number",
"description": "Optional additional withholding amount",
"format": "double",
"nullable": true
}
},
"additionalProperties": false,
"description": "Request model for North Carolina NC-4 Tax Form for the year 2025."
},
"TwApi.Services.Enrollment.API.Models.OhioIT4TaxForm2024Model": {
"required": [
"dependents",
"exemptFullYearResident",
"exemptNonResidentMilitary",
"exemptNonResidentMilitarySpouse",
"exemptRC5747",
"exemptResidentMilitary",
"firstName",
"governmentPersonalIdentifier",
"lastName",
"line1PersonalExemption",
"line2SpousalExemption",
"municipality",
"postalCode",
"region",
"street1"
],
"type": "object",
"properties": {
"firstName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee first name as it appears on their Social Security card."
},
"middleInitial": {
"maxLength": 1,
"minLength": 0,
"type": "string",
"description": "Employee middle initial.",
"nullable": true
},
"lastName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee last name as it appears on their Social Security card."
},
"governmentPersonalIdentifier": {
"minLength": 1,
"pattern": "^\\d{3}-\\d{2}-\\d{4}$",
"type": "string",
"description": "Employee Social Security Number in the format xxx-xx-xxxx."
},
"street1": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee physical address (line 1)."
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee city."
},
"region": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Two-letter state or territory abbreviation (e.g., OH)."
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"pattern": "^\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Postal/ZIP code in 5-digit or 5+4 format."
},
"schoolDistrictName": {
"maxLength": 100,
"minLength": 0,
"type": "string",
"description": "School district of residence name (e.g., \"Columbus City\"). Stored for reference only — does not\r\naffect tax calculation. Use the Ohio Department of Taxation's \"The Finder\" tool or\r\n`GET /Datalists/TaxJurisdictions/SchoolDistricts?taxRegion=OH` to look up valid names.",
"nullable": true
},
"schoolDistrictNumber": {
"maximum": 2147483647,
"minimum": 1,
"type": "integer",
"description": "School district number (e.g., 2503 for Columbus City). Used to look up the school\r\ndistrict tax jurisdiction. Valid numbers can be found via the Ohio Department of Taxation's \"The Finder\"\r\ntool or `GET /Datalists/TaxJurisdictions/SchoolDistricts?taxRegion=OH`. If the number does not\r\nresolve to a valid Ohio school district, a 400 validation error is returned.",
"format": "int32",
"nullable": true
},
"line1PersonalExemption": {
"maximum": 1,
"minimum": 0,
"type": "integer",
"description": "Section II, Line 1. Enter 1 if you are NOT a dependent on another individual's Ohio return; otherwise enter 0.",
"format": "int32"
},
"line2SpousalExemption": {
"maximum": 1,
"minimum": 0,
"type": "integer",
"description": "Section II, Line 2. Enter 1 if you are married and your spouse does NOT file a separate Ohio return; otherwise enter 0.",
"format": "int32"
},
"dependents": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "Section II, Line 3. Number of dependents.",
"format": "int32"
},
"additionalWithholding": {
"minimum": 0,
"type": "number",
"description": "Section II, Line 5. Additional Ohio income tax withholding per pay period (optional).",
"format": "double",
"nullable": true
},
"exemptFullYearResident": {
"type": "boolean",
"description": "Section III. I am a full-year resident of Indiana, Kentucky, Michigan, Pennsylvania, or West Virginia."
},
"exemptResidentMilitary": {
"type": "boolean",
"description": "Section III. I am a resident military servicemember who is stationed outside Ohio on active duty military orders."
},
"exemptNonResidentMilitary": {
"type": "boolean",
"description": "Section III. I am a nonresident military servicemember who is stationed in Ohio due to military orders."
},
"exemptNonResidentMilitarySpouse": {
"type": "boolean",
"description": "Section III. I am a nonresident civilian spouse of a military servicemember and I am present in Ohio solely\r\ndue to my spouse's military orders."
},
"exemptRC5747": {
"type": "boolean",
"description": "Section III. I am exempt from Ohio withholding under R.C. 5747.06(A)(1) through (6)."
}
},
"additionalProperties": false,
"description": "Request model for Ohio IT 4 (Employee's Withholding Exemption Certificate) for the 01/24 form revision."
},
"TwApi.Services.Enrollment.API.Models.OklahomaOKW4TaxForm2021Model": {
"required": [
"firstName",
"governmentPersonalIdentifier",
"lastName",
"line7Exempt",
"line8ExemptMilitarySpouse",
"line9ExemptMilitaryIncome",
"married",
"marriedButWithholdAtHigherSingleRate",
"municipality",
"postalCode",
"region",
"single",
"street1"
],
"type": "object",
"properties": {
"firstName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee first name as it appears on their Social Security card."
},
"middleInitial": {
"maxLength": 1,
"minLength": 0,
"type": "string",
"description": "Employee middle initial.",
"nullable": true
},
"lastName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee last name as it appears on their Social Security card."
},
"governmentPersonalIdentifier": {
"minLength": 1,
"pattern": "^\\d{3}-\\d{2}-\\d{4}$",
"type": "string",
"description": "Employee Social Security Number in the format xxx-xx-xxxx."
},
"street1": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee home address (Number and Street or Rural Route)."
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee city or town."
},
"region": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Two-letter state or territory abbreviation (e.g., OK)."
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"pattern": "^\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Postal/ZIP code in 5-digit or 5+4 format."
},
"single": {
"type": "boolean",
"description": "Filing status: Single."
},
"married": {
"type": "boolean",
"description": "Filing status: Married."
},
"marriedButWithholdAtHigherSingleRate": {
"type": "boolean",
"description": "Filing status: Married, but withhold at higher Single rate."
},
"line1AllowanceForYourself": {
"maximum": 1,
"minimum": 0,
"type": "integer",
"description": "Line 1. Allowance for yourself: Enter 1 for yourself (0 or 1).",
"format": "int32",
"nullable": true
},
"line2SpouseWorks": {
"type": "boolean",
"description": "Line 2. Does your spouse work? True if yes, false if no.\r\nIf yes, Line2AllowanceForSpouse should be 0. If no, Line2AllowanceForSpouse should be 1.",
"nullable": true
},
"line2AllowanceForSpouse": {
"maximum": 1,
"minimum": 0,
"type": "integer",
"description": "Line 2. Allowance for your spouse: If your spouse works, enter 0. If not, enter 1 for your spouse (0 or 1).",
"format": "int32",
"nullable": true
},
"line3Dependents": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "Line 3. Allowance for dependents: Enter the number of dependents you will claim on your tax return.\r\nDo not claim yourself or your spouse or dependents that your spouse has already claimed.",
"format": "int32",
"nullable": true
},
"line4AdditionalAllowances": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "Line 4. Additional allowances: You may claim additional allowances if you itemize your deductions\r\nor have other state tax deductions or credits that lower your tax.",
"format": "int32",
"nullable": true
},
"line5TotalExemptions": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "Line 5. Total number of allowances you are claiming: Add Lines 1 through 4 and enter total here.",
"format": "int32",
"nullable": true
},
"line6AdditionalWithholding": {
"minimum": 0,
"type": "number",
"description": "Line 6. Additional withholding: Enter the additional amount to be withheld each pay period.",
"format": "double",
"nullable": true
},
"line7Exempt": {
"type": "boolean",
"description": "Line 7. Exempt status: You had no tax liability last year and expect none this year."
},
"line8ExemptMilitarySpouse": {
"type": "boolean",
"description": "Line 8. Exempt under the Servicemember Civil Relief Act, as amended by the Military Spouses\r\nResidency Relief Act, and have no Oklahoma tax liability."
},
"line9ExemptMilitaryIncome": {
"type": "boolean",
"description": "Line 9. Exempt because income is earned as a member of any active duty component of the Armed Forces\r\nand is eligible for the military income deduction."
}
},
"additionalProperties": false,
"description": "Request model for Oklahoma OK-W-4 (Employee's State Withholding Allowance Certificate) for the 2021 form revision."
},
"TwApi.Services.Enrollment.API.Models.OregonORW4TaxForm2026Model": {
"required": [
"firstName",
"governmentPersonalIdentifier",
"isMarried",
"isMarriedButHigherWithholding",
"isRedetermination",
"isSingleOrMarriedFilingSeparately",
"lastName",
"municipality",
"postalCode",
"region",
"street1"
],
"type": "object",
"properties": {
"firstName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee first name as it appears on their Social Security card."
},
"middleIntial": {
"maxLength": 1,
"minLength": 0,
"type": "string",
"description": "Employee middle initial as it appears on their Social Security card.",
"nullable": true
},
"lastName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee last name as it appears on their Social Security card."
},
"governmentPersonalIdentifier": {
"minLength": 1,
"pattern": "^\\d{3}-\\d{2}-\\d{4}$",
"type": "string",
"description": "Employee Social Security Number in the format xxx-xx-xxxx."
},
"isRedetermination": {
"type": "boolean",
"description": "Are you a redetermination."
},
"street1": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee street address (line 1)."
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee municipality(city)."
},
"region": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Two-letter state or territory abbreviation (e.g., MO)."
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"pattern": "^\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Postal/ZIP code in 5-digit or 5+4 format."
},
"isSingleOrMarriedFilingSeparately": {
"type": "boolean",
"description": "Filing status: Single or Married Spouse Works or Married Filing Separate."
},
"isMarried": {
"type": "boolean",
"description": "Filing status: Married"
},
"isMarriedButHigherWithholding": {
"type": "boolean",
"description": "Filing status: Married, but withhold at the higher single rate."
},
"allowances": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "Enter the number of Allowances you will claim on your tax return.",
"format": "int32",
"nullable": true
},
"additionalWithholding": {
"maximum": 2147483647,
"minimum": 0,
"type": "number",
"description": "Additional withholding deducted per pay period.",
"format": "double",
"nullable": true
},
"witholdingExemptionCode": {
"maxLength": 1,
"minLength": 0,
"type": "string",
"description": "The withholding exemption code.",
"nullable": true
},
"exemption": {
"maxLength": 6,
"minLength": 0,
"type": "string",
"description": "Write Exempt to claim the withholding exemption.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Request model for Oregon OR-W-4 Tax Form for the year 2026."
},
"TwApi.Services.Enrollment.API.Models.PuertoRico499R41TaxForm2016Model": {
"required": [
"employerStreet1",
"firstName",
"governmentPersonalIdentifier",
"jurisdiction",
"lastName",
"municipality",
"postalCode",
"region",
"street1"
],
"type": "object",
"properties": {
"firstName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee first name as it appears on their Social Security card."
},
"lastName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee last name as it appears on their Social Security card."
},
"governmentPersonalIdentifier": {
"minLength": 1,
"pattern": "^\\d{3}-\\d{2}-\\d{4}$",
"type": "string",
"description": "Employee Social Security Number in the format xxx-xx-xxxx."
},
"street1": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee street address (line 1)."
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee municipality (municipio)."
},
"region": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Two-letter state or territory abbreviation (e.g., PR)."
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"pattern": "^\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Postal/ZIP code in 5-digit or 5+4 format."
},
"singleComplete": {
"type": "boolean",
"description": "Personal exemption: Single, claimed complete (SC). Maps to jurisdiction PRSINGLE."
},
"singleNone": {
"type": "boolean",
"description": "Personal exemption: Single, claimed none (SN). Maps to jurisdiction PRMNONE."
},
"marriedComplete": {
"type": "boolean",
"description": "Personal exemption: Married, claimed complete (MC). Maps to jurisdiction PRMFULL."
},
"marriedHalf": {
"type": "boolean",
"description": "Personal exemption: Married, claimed on a 50% basis (MH). Maps to jurisdiction PRMHALF."
},
"marriedNone": {
"type": "boolean",
"description": "Personal exemption: Married, claimed none (MN). Maps to jurisdiction PRMNONE."
},
"deductionHomeMortgageInterest": {
"maximum": 2147483647,
"minimum": 0,
"type": "number",
"description": "Section C, line 1(a): Home mortgage interests.",
"format": "double",
"nullable": true
},
"deductionCharitableContributions": {
"maximum": 2147483647,
"minimum": 0,
"type": "number",
"description": "Section C, line 1(b): Charitable contributions.",
"format": "double",
"nullable": true
},
"deductionMedicalExpenses": {
"maximum": 2147483647,
"minimum": 0,
"type": "number",
"description": "Section C, line 1(c): Medical expenses.",
"format": "double",
"nullable": true
},
"deductionStudentLoanInterest": {
"maximum": 2147483647,
"minimum": 0,
"type": "number",
"description": "Section C, line 1(d): Interest paid on student loans at university level.",
"format": "double",
"nullable": true
},
"deductionGovernmentalPensionContributions": {
"maximum": 2147483647,
"minimum": 0,
"type": "number",
"description": "Section C, line 1(e): Contributions to governmental pension or retirement systems.",
"format": "double",
"nullable": true
},
"deductionIndividualRetirementContributions": {
"maximum": 2147483647,
"minimum": 0,
"type": "number",
"description": "Section C, line 1(f): Contributions to individual retirement accounts.",
"format": "double",
"nullable": true
},
"deductionEducationalContributions": {
"maximum": 2147483647,
"minimum": 0,
"type": "number",
"description": "Section C, line 1(g): Educational contributions account.",
"format": "double",
"nullable": true
},
"deductionHealthSavingsContributions": {
"maximum": 2147483647,
"minimum": 0,
"type": "number",
"description": "Section C, line 1(h): Contributions to health savings accounts.",
"format": "double",
"nullable": true
},
"deductionCasualtyLossPrincipalResidence": {
"maximum": 2147483647,
"minimum": 0,
"type": "number",
"description": "Section C, line 1(i): Casualty loss on your principal residence.",
"format": "double",
"nullable": true
},
"deductionPersonalPropertyLoss": {
"maximum": 2147483647,
"minimum": 0,
"type": "number",
"description": "Section C, line 1(j): Loss of personal property as a result of certain casualties.",
"format": "double",
"nullable": true
},
"deductionTotal": {
"maximum": 2147483647,
"minimum": 0,
"type": "number",
"description": "Section C, line 1(k): Total deductions (sum of lines 1a–1j). Derivable from the\r\nindividual line items; captured as submitted.",
"format": "double",
"nullable": true
},
"isGovernmentalPensionParticipant": {
"type": "boolean",
"description": "Section C: Check here if you are a governmental employee who participates in a\r\nPension or Retirement System."
},
"percentage": {
"maximum": 100,
"minimum": 0,
"type": "number",
"description": "Flat withholding percentage, when the election is expressed as a\r\npercentage rather than a fixed amount. Range 0–100.",
"format": "double",
"nullable": true
},
"amount": {
"maximum": 2147483647,
"minimum": 0,
"type": "number",
"description": "Flat withholding amount, when the election is expressed as a fixed\r\namount rather than a percentage.",
"format": "double",
"nullable": true
},
"allowances": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "Total allowances based on deductions the employee is claiming\r\n(allowance based on deductions, Part C).",
"format": "int32",
"nullable": true
},
"itemizedAllowances": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "Itemized/estimated allowances based on itemized deductions.\r\nMaps to AllowancesEstimated on the employee tax record.",
"format": "int32",
"nullable": true
},
"allowanceComplete": {
"type": "boolean",
"description": "Allowance-based personal exemption election: Complete (ALL_C).\r\nWhen either allowance-based election is set, SpecialPersonalEx is flagged."
},
"allowanceNone": {
"type": "boolean",
"description": "Allowance-based personal exemption election: None (ALL_N).\r\nWhen either allowance-based election is set, SpecialPersonalEx is flagged."
},
"dependentsExemption": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "Number of dependents for the personal/complete exemption (DependentsExemption).",
"format": "int32",
"nullable": true
},
"dependentsJointCustody": {
"maximum": 99,
"minimum": 0,
"type": "number",
"description": "Joint-custody dependents (DependentsJC). When present and non-zero, the\r\ndependent count is computed as ROUND(DependentsExemption + (DependentsExemption * 0.5), 0).",
"format": "double",
"nullable": true
},
"exempt": {
"type": "boolean",
"description": "Whether the employee is exempt from Puerto Rico income tax withholding."
},
"additionalWithholdingAmount": {
"maximum": 2147483647,
"minimum": 0,
"type": "number",
"description": "Additional amount, if any, the employee authorizes the employer to\r\nwithhold each pay period in addition to the tax otherwise required\r\n(Part D, Section 1062.01(e) of the Code).",
"format": "double",
"nullable": true
},
"additionalWithholdingPercentage": {
"maximum": 100,
"minimum": 0,
"type": "number",
"description": "Additional withholding percentage, when the additional election is\r\nexpressed as a percentage. Stored as a decimal fraction on the tax record\r\n(value / 100). Range 0–100.",
"format": "double",
"nullable": true
},
"stateExemptions": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "Number of Puerto Rico (state) personal/dependent exemptions claimed,\r\nused as the basis for withholding.",
"format": "int32",
"nullable": true
},
"veteranAdditionalExemption": {
"type": "boolean",
"description": "The veteran additional personal exemption election (line A3):\r\ntrue = \"Complete\" (claim in full, derives an additional allowance of 1),\r\nfalse or null = \"None\" (derives 0). Defaults to 0 (None) when not provided.",
"nullable": true
},
"jurisdiction": {
"maxLength": 10,
"minLength": 0,
"type": "string",
"description": "Taxing jurisdiction code for this certificate (e.g., PR)."
},
"employerName": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employer name.",
"nullable": true
},
"employerStreet1": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employer street address (line 1)."
},
"employerMunicipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employer municipality (municipio).",
"nullable": true
},
"employerRegion": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Two-letter state or territory abbreviation (e.g., PR).",
"nullable": true
},
"employerPostalCode": {
"maxLength": 10,
"minLength": 0,
"pattern": "^\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Employer Postal/ZIP code in 5-digit or 5+4 format.",
"nullable": true
},
"employerIdentificationNumber": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employer identification / Puerto Rico withholding account number.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Request model for the Puerto Rico Withholding Exemption Certificate\r\n(Form 499 R-4.1, Puerto Rico's federal W-4 equivalent) for the 2016 revision."
},
"TwApi.Services.Enrollment.API.Models.RhodeIslandRIW4TaxForm2025Model": {
"required": [
"firstName",
"governmentPersonalIdentifier",
"lastName",
"line1ANotClaimedAsDependent",
"line1BClaimingSpouseAsDependent",
"municipality",
"postalCode",
"region",
"street1"
],
"type": "object",
"properties": {
"firstName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee first name as it appears on their Social Security card."
},
"middleInitial": {
"maxLength": 1,
"minLength": 0,
"type": "string",
"description": "Employee middle initial as it appears on their Social Security card.",
"nullable": true
},
"lastName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Last Name as it appears on their Social Security card."
},
"governmentPersonalIdentifier": {
"minLength": 1,
"pattern": "^\\d{3}-\\d{2}-\\d{4}$",
"type": "string",
"description": "Your social security number."
},
"street1": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Home address (number and street)"
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "City or town"
},
"region": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Two-letter state or territory abbreviation (e.g., RI)."
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"pattern": "^\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Postal/ZIP code in 5-digit or 5+4 format."
},
"line1ANotClaimedAsDependent": {
"type": "boolean",
"description": "Line 1.A No one else can claim me as a dependent."
},
"line1BClaimingSpouseAsDependent": {
"type": "boolean",
"description": "Line 1.B I can claim my spouse as a dependent."
},
"line1CDependents": {
"type": "integer",
"description": "Line 1.C Enter the number of dependents (Other than you our your spouse) you will claim on your tax return.",
"format": "int32",
"nullable": true
},
"line1DAdditionalAllowances": {
"type": "integer",
"description": "Line 1.D Enter any additional allowances (review carefully to avoid underwithholding)",
"format": "int32",
"nullable": true
},
"line1TotalAllowances": {
"maximum": 10,
"minimum": 0,
"type": "integer",
"description": "Line 1: Total number of personal allowances",
"format": "int32",
"nullable": true
},
"line2AdditionalWithholdingAmount": {
"minimum": 0,
"type": "number",
"description": "Line 2: Enter any Additional dollar amount which you would like withheld from your pay",
"format": "double",
"nullable": true
},
"line3Exempt": {
"type": "string",
"description": "Line 3: Exempt from withholding status Either left blank, 'EXEMPT' or 'EXEMPT-MS'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Request model for Rhode Island state withholding Tax Form W-4 for the year 2025."
},
"TwApi.Services.Enrollment.API.Models.SecondaryDirectDepositAccountRequest": {
"required": [
"accountNumber",
"accountTypeId",
"routingNumber"
],
"type": "object",
"properties": {
"routingNumber": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "The routing number of the bank where the secondary direct deposit account is held.",
"nullable": true
},
"accountNumber": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "The account number of the secondary direct deposit account.",
"nullable": true
},
"accountTypeId": {
"maxLength": 3,
"minLength": 0,
"type": "string",
"description": "The type of the employee's bank account. Valid options: Chk or Sav.",
"nullable": true
},
"takeFlatAmount": {
"maximum": 9999999.99,
"minimum": 0,
"type": "number",
"description": "The flat amount of the employee's pay to be deposited into the secondary direct deposit account.",
"format": "double",
"nullable": true
},
"takePercentage": {
"maximum": 100,
"minimum": 0,
"type": "number",
"description": "The percentage of the employee's pay to be deposited into the secondary direct deposit account.",
"format": "double",
"nullable": true
}
},
"additionalProperties": false,
"description": "Request Model for a secondary direct deposit account."
},
"TwApi.Services.Enrollment.API.Models.SouthCarolinaSCW4TaxForm2026Model": {
"required": [
"allowances",
"firstName",
"governmentPersonalIdentifier",
"isMarried",
"isMarriedButHigherWithholding",
"isSingleOrMarriedFilingSeparately",
"lastName",
"municipality",
"postalCode",
"region",
"street1"
],
"type": "object",
"properties": {
"firstName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee first name as it appears on their Social Security card."
},
"middleIntial": {
"maxLength": 1,
"minLength": 0,
"type": "string",
"description": "Employee middle initial as it appears on their Social Security card.",
"nullable": true
},
"lastName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee last name as it appears on their Social Security card."
},
"governmentPersonalIdentifier": {
"minLength": 1,
"pattern": "^\\d{3}-\\d{2}-\\d{4}$",
"type": "string",
"description": "Employee Social Security Number in the format xxx-xx-xxxx."
},
"street1": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee street address (line 1)."
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee municipality(city)."
},
"region": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Two-letter state or territory abbreviation (e.g., MO)."
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"pattern": "^\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Postal/ZIP code in 5-digit or 5+4 format."
},
"isSingleOrMarriedFilingSeparately": {
"type": "boolean",
"description": "Filing status: Single or Married Spouse Works or Married Filing Separate."
},
"isMarried": {
"type": "boolean",
"description": "Filing status: Married"
},
"isMarriedButHigherWithholding": {
"type": "boolean",
"description": "Filing status: Married, but withhold at the higher single rate."
},
"isDifferentLastName": {
"type": "boolean",
"description": "Check if your last name is different on your Social Security card."
},
"allowances": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "Enter the number of Allowances you will claim on your tax return.",
"format": "int32"
},
"additionalWithholding": {
"maximum": 2147483647,
"minimum": 0,
"type": "number",
"description": "Additional withholding deducted per pay period.",
"format": "double",
"nullable": true
},
"isWithholdingExemption": {
"type": "boolean",
"description": "Check if you claim exemption from withholding."
},
"isMilitarySpouseStateExemption": {
"type": "boolean",
"description": "Check if the individual qualifies for a state tax exemption as a military spouse."
},
"stateOfDomicile": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Two-letter state or territory abbreviation (e.g., MO). Required only when claiming military spouse exemption.",
"nullable": true
},
"exemption": {
"maxLength": 6,
"minLength": 0,
"pattern": "^(?:Exempt)?$",
"type": "string",
"description": "Write Exempt to claim the withholding exemption.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Request model for South Carolina SC-W-4 Tax Form for the year 2026."
},
"TwApi.Services.Enrollment.API.Models.VermontW4VT2018Model": {
"required": [
"firstName",
"governmentPersonalIdentifier",
"isExempt",
"lastName",
"line1SelfExemption",
"line2SpouseExemption",
"line3Dependents",
"line4HeadOfHousehold",
"line5TotalAllowances",
"marriedCivilUnionFilingJointly",
"marriedCivilUnionFilingSeparately",
"marriedWithholdHigherSingleRate",
"municipality",
"postalCode",
"region",
"single",
"street1"
],
"type": "object",
"properties": {
"firstName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee first name as it appears on their Social Security card."
},
"middleInitial": {
"maxLength": 1,
"minLength": 0,
"type": "string",
"description": "Employee middle initial.",
"nullable": true
},
"lastName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee last name as it appears on their Social Security card."
},
"governmentPersonalIdentifier": {
"minLength": 1,
"pattern": "^\\d{3}-\\d{2}-\\d{4}$",
"type": "string",
"description": "Employee Social Security Number in the format xxx-xx-xxxx."
},
"street1": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee home address (Number and Street)."
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee city or town."
},
"region": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Two-letter state or territory abbreviation (e.g., VT)."
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"pattern": "^\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Postal/ZIP code in 5-digit or 5+4 format."
},
"single": {
"type": "boolean",
"description": "Filing Status. Single. One and only one filing status may be selected."
},
"marriedCivilUnionFilingJointly": {
"type": "boolean",
"description": "Filing Status. Married/Civil Union Filing Jointly. One and only one filing status may be selected.\r\nThis is the only status that maps to Married."
},
"marriedCivilUnionFilingSeparately": {
"type": "boolean",
"description": "Filing Status. Married/Civil Union Filing Separately. One and only one filing status may be selected."
},
"marriedWithholdHigherSingleRate": {
"type": "boolean",
"description": "Filing Status. Married, but withhold at higher single rate. One and only one filing status may be selected."
},
"line1SelfExemption": {
"maximum": 1,
"minimum": 0,
"type": "integer",
"description": "Line 1. Enter \"1\" for yourself if no one can claim you as a dependent.",
"format": "int32"
},
"line2SpouseExemption": {
"maximum": 1,
"minimum": 0,
"type": "integer",
"description": "Line 2. Enter \"1\" if you are filing jointly and your spouse does not work.",
"format": "int32"
},
"line3Dependents": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "Line 3. Enter the number of dependents you plan to claim on your tax return.",
"format": "int32"
},
"line4HeadOfHousehold": {
"maximum": 1,
"minimum": 0,
"type": "integer",
"description": "Line 4. Enter \"1\" if you plan to file as \"head of household\".",
"format": "int32"
},
"line5TotalAllowances": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "Line 5. Total number of Vermont allowances. Must equal Line1 + Line2 + Line3 + Line4.",
"format": "int32"
},
"line6AdditionalWithholding": {
"minimum": 0,
"type": "number",
"description": "Line 6. Enter an additional amount, if any, you want withheld from each check.",
"format": "double",
"nullable": true
},
"isExempt": {
"type": "boolean",
"description": "Exempt. If you had a right to a refund of all your Vermont income tax withheld last year and you expect to\r\nhave no liability this year, you may claim exempt from withholding."
}
},
"additionalProperties": false,
"description": "Request model for Vermont Form W-4VT (Employee's Withholding Allowance Certificate) for the 2018 form revision (Rev. 12/18)."
},
"TwApi.Services.Enrollment.API.Models.VirginiaVA4TaxForm2011Model": {
"required": [
"exemptionAgeSelf",
"exemptionAgeSpouse",
"exemptionBlindSelf",
"exemptionBlindSpouse",
"exemptionDependents",
"exemptionSelf",
"exemptionSpouse",
"firstName",
"governmentPersonalIdentifier",
"lastName",
"municipality",
"postalCode",
"region",
"street1",
"worksheetSubtotalAgeBlindExemptions",
"worksheetSubtotalPersonalExemptions",
"worksheetTotalExemptions"
],
"type": "object",
"properties": {
"firstName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee first name as it appears on their Social Security card."
},
"lastName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee last name as it appears on their Social Security card."
},
"governmentPersonalIdentifier": {
"minLength": 1,
"pattern": "^\\d{3}-\\d{2}-\\d{4}$",
"type": "string",
"description": "Employee Social Security Number in the format xxx-xx-xxxx."
},
"street1": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee street address (line 1)."
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee Municipality."
},
"region": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Two-letter state or territory abbreviation (e.g., VA)."
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"pattern": "^\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Postal/ZIP code in 5-digit or 5+4 format."
},
"exemptionSelf": {
"maximum": 1,
"minimum": 0,
"type": "integer",
"description": "Line 1: If you wish to claim yourself, write \"1\".",
"format": "int32"
},
"exemptionSpouse": {
"maximum": 1,
"minimum": 0,
"type": "integer",
"description": "Line 2: If you are married and your spouse is not claimed on his or her own certificate, write \"1\".",
"format": "int32"
},
"exemptionDependents": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "Line 3: Number of dependents you will be allowed to claim on your income tax return (do not include your spouse).",
"format": "int32"
},
"worksheetSubtotalPersonalExemptions": {
"maximum": 101,
"minimum": 0,
"type": "integer",
"description": "Worksheet Line 4: Subtotal Personal Exemptions (add lines 1 through 3).",
"format": "int32"
},
"exemptionAgeSelf": {
"maximum": 1,
"minimum": 0,
"type": "integer",
"description": "Worksheet Line 5(a): If you will be 65 or older on January 1, write \"1\".",
"format": "int32"
},
"exemptionAgeSpouse": {
"maximum": 1,
"minimum": 0,
"type": "integer",
"description": "Worksheet Line 5(b): If you claimed an exemption on line 2 and your spouse will be 65 or older on January 1, write \"1\".",
"format": "int32"
},
"exemptionBlindSelf": {
"maximum": 1,
"minimum": 0,
"type": "integer",
"description": "Worksheet Line 6(a): If you are legally blind, write \"1\".",
"format": "int32"
},
"exemptionBlindSpouse": {
"maximum": 1,
"minimum": 0,
"type": "integer",
"description": "Worksheet Line 6(b): If you claimed an exemption on line 2 and your spouse is legally blind, write \"1\".",
"format": "int32"
},
"worksheetSubtotalAgeBlindExemptions": {
"maximum": 4,
"minimum": 0,
"type": "integer",
"description": "Worksheet Line 7: Subtotal exemptions for age and blindness (add lines 5 through 6).",
"format": "int32"
},
"worksheetTotalExemptions": {
"maximum": 105,
"minimum": 0,
"type": "integer",
"description": "Worksheet Line 8: Total of Exemptions - add line 4 and line 7.",
"format": "int32"
},
"certificateSubtotalPersonalExemptions": {
"maximum": 101,
"minimum": 0,
"type": "integer",
"description": "Certificate Line 1(a): Subtotal of Personal Exemptions - line 4 of the Personal Exemption Worksheet.",
"format": "int32",
"nullable": true
},
"certificateSubtotalAgeBlindExemptions": {
"maximum": 4,
"minimum": 0,
"type": "integer",
"description": "Certificate Line 1(b): Subtotal of Exemptions for Age and Blindness - line 7 of the Personal Exemption Worksheet.",
"format": "int32",
"nullable": true
},
"certificateTotalExemptions": {
"maximum": 105,
"minimum": 0,
"type": "integer",
"description": "Certificate Line 1(c): Total Exemptions - line 8 of the Personal Exemption Worksheet.",
"format": "int32",
"nullable": true
},
"additionalWithholdingAmount": {
"minimum": 0,
"type": "number",
"description": "Certificate Line 2: Additional amount to withhold from each paycheck.",
"format": "double",
"nullable": true
},
"isExemptFromWithholding": {
"type": "boolean",
"description": "Certificate Line 3: Check if not subject to Virginia withholding (meets conditions set forth in instructions)."
},
"isMilitarySpouseExempt": {
"type": "boolean",
"description": "Certificate Line 4: Check if not subject to Virginia withholding under Service member Civil Relief Act (Military Spouses Residency Relief Act)."
}
},
"additionalProperties": false,
"description": "Request model for Virginia VA-4 Tax Form for the year 2011."
},
"TwApi.Services.Enrollment.API.Models.WestVirginiaWVIT104TaxForm2023Model": {
"required": [
"firstName",
"governmentPersonalIdentifier",
"lastName",
"line1SingleExemption",
"line2MarriedExemptions",
"line3Dependents",
"line4TotalExemptions",
"line5LowerWithholdingRate",
"municipality",
"postalCode",
"region",
"street1"
],
"type": "object",
"properties": {
"firstName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee first name as it appears on their Social Security card."
},
"middleInitial": {
"maxLength": 1,
"minLength": 0,
"type": "string",
"description": "Employee middle initial.",
"nullable": true
},
"lastName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee last name as it appears on their Social Security card."
},
"governmentPersonalIdentifier": {
"minLength": 1,
"pattern": "^\\d{3}-\\d{2}-\\d{4}$",
"type": "string",
"description": "Employee Social Security Number in the format xxx-xx-xxxx."
},
"street1": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee home address (Number and Street)."
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee city or town."
},
"region": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Two-letter state or territory abbreviation (e.g., WV)."
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"pattern": "^\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Postal/ZIP code in 5-digit or 5+4 format."
},
"line1SingleExemption": {
"maximum": 1,
"minimum": 0,
"type": "integer",
"description": "Line 1. If SINGLE, and you claim an exemption, enter \"1\"; if you do not, enter \"0\".",
"format": "int32"
},
"line2MarriedExemptions": {
"maximum": 2,
"minimum": 0,
"type": "integer",
"description": "Line 2. If MARRIED, one exemption each for husband and wife if not claimed on another certificate.\r\n(a) If you claim both of these exemptions, enter \"2\".\r\n(b) If you claim one of these exemptions, enter \"1\".\r\n(c) If you claim neither of these exemptions, enter \"0\".",
"format": "int32"
},
"line3Dependents": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "Line 3. If you claim exemptions for one or more dependents, enter the number of such exemptions.",
"format": "int32"
},
"line4TotalExemptions": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "Line 4. Add the number of exemptions which you have claimed above and enter the total.\r\nMust equal Line1 + Line2 + Line3.",
"format": "int32"
},
"line5LowerWithholdingRate": {
"type": "boolean",
"description": "Line 5. If you are Single, Head of Household, or Married and your spouse does not work, and you are\r\nreceiving wages from only one job, and you wish to have your tax withheld at a lower rate, check here."
},
"line6AdditionalWithholding": {
"minimum": 0,
"type": "number",
"description": "Line 6. Additional withholding per pay period under agreement with employer, enter amount here.",
"format": "double",
"nullable": true
}
},
"additionalProperties": false,
"description": "Request model for West Virginia WV IT-104 (Employee's Withholding Exemption Certificate) for the March 2023 form revision."
},
"TwApi.Services.Enrollment.API.Models.WisconsinWT4TaxForm2023Model": {
"required": [
"firstName",
"governmentPersonalIdentifier",
"isMarried",
"isMarriedButWithholdAtHigherSingleRate",
"isSingle",
"lastName",
"line3IsExempt",
"municipality",
"postalCode",
"region",
"street1"
],
"type": "object",
"properties": {
"firstName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee first name as it appears on their Social Security card."
},
"middleInitial": {
"maxLength": 1,
"minLength": 0,
"type": "string",
"description": "Employee middle initial (optional).",
"nullable": true
},
"lastName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee last name as it appears on their Social Security card."
},
"governmentPersonalIdentifier": {
"minLength": 1,
"pattern": "^\\d{3}-\\d{2}-\\d{4}$",
"type": "string",
"description": "Employee Social Security Number in the format xxx-xx-xxxx."
},
"street1": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee street address (line 1)."
},
"dateOfBirth": {
"type": "string",
"description": "Employee date of birth (optional).",
"format": "date",
"nullable": true
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee Municipality (city)."
},
"region": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Two-letter state or territory abbreviation (e.g., WI)."
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"pattern": "^\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Postal/ZIP code in 5-digit or 5+4 format."
},
"dateOfHire": {
"type": "string",
"description": "Employee date of hire (optional).",
"format": "date",
"nullable": true
},
"isSingle": {
"type": "boolean",
"description": "If the employee is filing as Single."
},
"isMarried": {
"type": "boolean",
"description": "If the employee is filing as Married."
},
"isMarriedButWithholdAtHigherSingleRate": {
"type": "boolean",
"description": "If the employee is Married but withhold at higher Single rate. \r\nNOTE: If married, but legally separated, check the Single box."
},
"line1AExemptionSelf": {
"maximum": 1,
"minimum": 0,
"type": "integer",
"description": "Line 1a: Exemption for yourself — enter 1.",
"format": "int32",
"nullable": true
},
"line1BExemptionSpouse": {
"maximum": 1,
"minimum": 0,
"type": "integer",
"description": "Line 1b: Exemption for your spouse — enter 1.",
"format": "int32",
"nullable": true
},
"line1CExemptionsDependents": {
"maximum": 99,
"minimum": 0,
"type": "integer",
"description": "Line 1c: Exemption(s) for dependent(s) — you are entitled to claim an exemption for each dependent.",
"format": "int32",
"nullable": true
},
"line1DTotal": {
"maximum": 101,
"minimum": 0,
"type": "integer",
"description": "Line 1d: Total — add lines (a) through (c).",
"format": "int32",
"nullable": true
},
"line2AdditionalWithholdingAmount": {
"minimum": 0,
"type": "number",
"description": "Line 2: Additional amount per pay period you want deducted (if your employer agrees).",
"format": "double",
"nullable": true
},
"line3IsExempt": {
"type": "boolean",
"description": "Line 3: Claim complete exemption from withholding (\"Exempt\")."
}
},
"additionalProperties": false,
"description": "Request model for Wisconsin WT-4 Tax Form (Form W-204, R. 8-23).\r\nMirrors the paper form fields, including Employee and Employer sections."
},
"TwApi.Services.EnrollmentService.API.Models.IndianaWH4TaxForm2023Model": {
"required": [
"countyOfPrincipalEmployment",
"countyOfResidence",
"firstName",
"governmentPersonalIdentifier",
"lastName",
"municipality",
"postalCode",
"region",
"street1",
"totalExemptions",
"totalExemptionsForQualifyingDependents"
],
"type": "object",
"properties": {
"firstName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee first name as it appears on their Social Security card."
},
"middleIntial": {
"maxLength": 1,
"minLength": 0,
"type": "string",
"description": "Employee middle initial as it appears on their Social Security card.",
"nullable": true
},
"lastName": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Employee Last name as it appears on their Social Security card."
},
"governmentPersonalIdentifier": {
"minLength": 1,
"pattern": "^\\d{3}-\\d{2}-\\d{4}$",
"type": "string",
"description": "Employee Social Security Number in the format xxx-xx-xxxx."
},
"street1": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee street address (line 1)."
},
"municipality": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Employee municipality(city)."
},
"region": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Two-letter state or territory abbreviation (e.g., MO)."
},
"postalCode": {
"maxLength": 10,
"minLength": 0,
"pattern": "^\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Postal/ZIP code in 5-digit or 5+4 format."
},
"countyOfResidence": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "County you live in"
},
"countyOfPrincipalEmployment": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "County you are employed in"
},
"changesToCounty": {
"type": "boolean",
"description": "Check this if the changes to the county are effective for your next calendar year"
},
"singleExemption": {
"type": "integer",
"description": "You are entitled to one exemption",
"format": "int32"
},
"marriedExemption": {
"type": "integer",
"description": "If you are married and your spouse does not claim the exemption",
"format": "int32"
},
"dependentExemption": {
"type": "integer",
"description": "Number of Exemptions for each dependent you are claiming",
"format": "int32"
},
"olderThanSixtyFive": {
"type": "boolean",
"description": "If you are older than than 65 years old"
},
"isBlind": {
"type": "boolean",
"description": "If you are blind"
},
"spouseIsOlderThanSixtyFive": {
"type": "boolean",
"description": "If your spouse is older than 65 years old"
},
"spouseIsBlind": {
"type": "boolean",
"description": "If your spouse is blind"
},
"totalNumberOfBoxesChecked": {
"type": "integer",
"description": "Total number of boxes (OlderThanSixtyFive, IsBlind, SpouseIsOlderThanSixtyFive, SpouseIsBlind)",
"format": "int32"
},
"totalExemptions": {
"type": "integer",
"description": "Add up SingleExemption, MarriedExemption, DependentExemption, and TotalNumberOfBoxesChecked",
"format": "int32"
},
"totalExemptionsForQualifyingDependents": {
"type": "integer",
"description": "Additional Exemption for Dependents",
"format": "int32"
},
"totalExemptionsForFirstTimeQualifyingDependents": {
"type": "integer",
"description": "Additional Exemption for First Time Dependents",
"format": "int32"
},
"totalExemptionsForAdoptedQualifyingDependents": {
"type": "integer",
"description": "Additional Exemption for Adopted Dependents",
"format": "int32"
},
"additionalStateWitholding": {
"type": "integer",
"description": "Any additional State Witholding you want to claim each pay period",
"format": "int32"
},
"additionalCountyWitholding": {
"type": "integer",
"description": "Any additional County Witholding you want to claim each pay period",
"format": "int32"
},
"signatureDate": {
"type": "string",
"description": "Date in which you are signing the form",
"format": "date"
}
},
"additionalProperties": false,
"description": "Request model for Indiana WH-4 Tax Form for the year 2024."
},
"TwApi.Services.HrCenter.API.Models.ChangeWebUserPasswordRequest": {
"required": [
"hrCenterProductInstanceId",
"newPassword",
"oldPassword",
"username"
],
"type": "object",
"properties": {
"hrCenterProductInstanceId": {
"type": "string",
"description": "HrCenter Product Instance Id",
"format": "uuid"
},
"username": {
"minLength": 1,
"type": "string",
"description": "HrCenter Web Username"
},
"oldPassword": {
"maxLength": 100,
"minLength": 7,
"type": "string",
"description": "Old Password"
},
"newPassword": {
"maxLength": 100,
"minLength": 7,
"type": "string",
"description": "New Password"
}
},
"additionalProperties": false,
"description": "Body of the request containing information about the WebUser account"
},
"TwApi.Services.HrCenter.Service.Client.Models.UserRecord": {
"type": "object",
"properties": {
"originId": {
"type": "integer",
"format": "int64"
},
"originTypeId": {
"$ref": "#/components/schemas/TwApi.Common.Enums.OriginType"
},
"fullName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.HrCenter.Service.Commands.GetPublicJobTitleList.Result": {
"type": "object",
"properties": {
"orderId": {
"type": "integer",
"format": "int64"
},
"jobTitle": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.HrCenter.Service.Commands.HrCenterSearchQuery.Result": {
"type": "object",
"properties": {
"employeeId": {
"type": "integer",
"format": "int64"
},
"productInstanceId": {
"type": "string",
"format": "uuid"
},
"productInstance": {
"type": "string",
"nullable": true
},
"employeeFirstName": {
"type": "string",
"nullable": true
},
"employeeLastName": {
"type": "string",
"nullable": true
},
"employeeMiddleName": {
"type": "string",
"nullable": true
},
"isEmployeeActive": {
"type": "boolean"
},
"employeeBranchId": {
"type": "integer",
"format": "int32"
},
"employeeBranch": {
"type": "string",
"nullable": true
},
"employeeServiceRepId": {
"type": "integer",
"format": "int32"
},
"employeeServiceRep": {
"type": "string",
"nullable": true
},
"employeeGovernmentPersonalId": {
"type": "string",
"nullable": true
},
"employeeEmailAddress": {
"type": "string",
"nullable": true
},
"employeePhoneNumber": {
"type": "string",
"nullable": true
},
"employeePhoneNumberCountryCallingCode": {
"type": "string",
"nullable": true
},
"webUserAccountId": {
"type": "string",
"format": "uuid"
},
"username": {
"type": "string",
"nullable": true
},
"stepInstanceId": {
"type": "string",
"format": "uuid"
},
"stepId": {
"type": "integer",
"format": "int32"
},
"step": {
"type": "string",
"nullable": true
},
"stepStatus": {
"type": "string",
"nullable": true
},
"dateStepCreated": {
"type": "string",
"format": "date-time"
},
"dateStepStarted": {
"type": "string",
"format": "date-time",
"nullable": true
},
"dateStepSubmitted": {
"type": "string",
"format": "date-time",
"nullable": true
},
"dateStepCompleted": {
"type": "string",
"format": "date-time",
"nullable": true
},
"dateWorkflowRejected": {
"type": "string",
"format": "date-time",
"nullable": true
},
"workflowInstanceId": {
"type": "string",
"format": "uuid"
},
"workflowId": {
"type": "integer",
"format": "int32"
},
"workflow": {
"type": "string",
"nullable": true
},
"assignedByFullName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.HrCenter.Service.Commands.ProductInstanceLanguageListQuery.Result": {
"type": "object",
"properties": {
"languageId": {
"type": "integer",
"format": "int32"
},
"language": {
"type": "string",
"nullable": true
},
"isDefault": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.HrCenter.Service.Commands.ProductInstancePagesListQuery.Result": {
"type": "object",
"properties": {
"pageId": {
"type": "integer",
"format": "int32"
},
"page": {
"type": "string",
"nullable": true
},
"category": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"secondaryActorsAreRequired": {
"type": "boolean"
},
"primaryActorType": {
"$ref": "#/components/schemas/TwApi.Common.Enums.ActorType"
},
"secondaryActorTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Enums.ActorType"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.HrCenter.Service.Commands.ProductInstanceStepsListQuery.Result": {
"type": "object",
"properties": {
"stepId": {
"type": "integer",
"format": "int32"
},
"step": {
"type": "string",
"nullable": true
},
"workflowId": {
"type": "integer",
"format": "int32"
},
"stepOrder": {
"type": "integer",
"format": "int32"
},
"isActive": {
"type": "boolean"
},
"secondaryActorsAreRequired": {
"type": "boolean"
},
"primaryActorType": {
"$ref": "#/components/schemas/TwApi.Common.Enums.ActorType"
},
"secondaryActorTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Enums.ActorType"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.HrCenter.Service.Commands.ProductInstanceWorkflowListQuery.Result": {
"type": "object",
"properties": {
"workflowId": {
"type": "integer",
"format": "int32"
},
"workflow": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"isAdditionalPagesWorkflow": {
"type": "boolean"
},
"isPublic": {
"type": "boolean"
},
"secondaryActorsAreRequired": {
"type": "boolean"
},
"primaryActorType": {
"$ref": "#/components/schemas/TwApi.Common.Enums.ActorType"
},
"secondaryActorTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Enums.ActorType"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.HrCenter.Service.Commands.ProductInstanceWorkflowStepPagesListQuery.Result": {
"type": "object",
"properties": {
"pageId": {
"type": "integer",
"format": "int32"
},
"page": {
"type": "string",
"nullable": true
},
"category": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"secondaryActorsAreRequired": {
"type": "boolean"
},
"primaryActorType": {
"$ref": "#/components/schemas/TwApi.Common.Enums.ActorType"
},
"secondaryActorTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Enums.ActorType"
},
"nullable": true
},
"pageOrder": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.HrCenter.Service.Commands.StepStatusListQuery.Result": {
"type": "object",
"properties": {
"stepStatus": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.HrCenter.Service.Commands.WebUserAccountSummaryQuery.Result": {
"type": "object",
"properties": {
"webUserId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"username": {
"type": "string",
"nullable": true
},
"originTypeId": {
"type": "integer",
"format": "int32"
},
"originId": {
"type": "integer",
"format": "int64"
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"primaryEmail": {
"type": "string",
"nullable": true
},
"branchId": {
"type": "integer",
"format": "int32"
},
"branchName": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.JobOrders.API.Models.AvailableMultiplierCodesCriteria": {
"type": "object",
"properties": {
"returnDefaultMultiplierCodeOnNoResults": {
"type": "boolean",
"description": "When true, the default multiplier code will be returned if the intersection of all customers defaults yields no results.\r\nDefaults to true when not explicitly defined."
},
"jobOrderIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "The list of job order Ids to be updated.",
"nullable": true
},
"assignmentIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "The list of assignment Ids to be updated.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Request object for obtaining the multiplier codes for mass update financials"
},
"TwApi.Services.JobOrders.API.Models.CreateAssignmentRestrictionSessionRequest": {
"required": [
"employeeId",
"isCandidateCheck"
],
"type": "object",
"properties": {
"employeeId": {
"type": "integer",
"description": "The Id of the Employee. A list of employees can be found at the search/employees or jobOrders/{jobOrderId}/candidates\r\nendpoints.",
"format": "int64"
},
"isCandidateCheck": {
"type": "boolean",
"description": "If true, checks to see if the specified employee can be made a candidate for the job order. Otherwise, checks to see if\r\nthe specified employee can be placed on assignment for the job order."
},
"assignmentStartDate": {
"type": "string",
"description": "An optional Start Date for the assignment. This may be used by some rules to check the employee's eligibility.\r\nThe date format is ISO 8601 YYYY-MM-DD.",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to begin an Assignment Restrictions session for an Employee against the Job Order"
},
"TwApi.Services.JobOrders.API.Models.CreateJobOrderAdjustmentRequest": {
"required": [
"adjustmentId",
"payCodeId"
],
"type": "object",
"properties": {
"adjustmentId": {
"type": "integer",
"description": "The Id of the Adjustment that is added to the JobOrder.",
"format": "int32"
},
"payCodeId": {
"type": "integer",
"description": "The Id of the PayCode that is set when adding the Adjustment to the JobOrder.",
"format": "int32"
},
"defaultPayRate": {
"maximum": 99999999.9999,
"minimum": -99999999.9999,
"type": "number",
"description": "The PayRate.",
"format": "double",
"nullable": true
},
"defaultBillRate": {
"maximum": 99999999.9999,
"minimum": -99999999.9999,
"type": "number",
"description": "The BillRate.",
"format": "double",
"nullable": true
}
},
"additionalProperties": false,
"description": "The request model for adding an Adjustment to a JobOrder."
},
"TwApi.Services.JobOrders.API.Models.CreateJobOrderCandidateRequest": {
"required": [
"assignmentRestrictionSessionId",
"employeeId",
"jobOrderCandidateStatusId"
],
"type": "object",
"properties": {
"employeeId": {
"type": "integer",
"description": "The Id of the Employee to be made a Candidate. A list of Employees can be found at the search/employees endpoint.",
"format": "int64"
},
"jobOrderCandidateStatusId": {
"type": "integer",
"description": "Valid values for JobOrderCandidateStatusId can be found in the Job Order Candidate Statuses Datalist.",
"format": "int32"
},
"assignmentRestrictionSessionId": {
"type": "string",
"description": "Assignment Restriction Sessions can be created with the Job Order > Create Assignment Restriction Session endpoint. All results from the session\r\nmust be approved before the employee can be assigned as a candidate.",
"format": "uuid"
}
},
"additionalProperties": false,
"description": "A request to add an Employee as a Candidate for the Job Order."
},
"TwApi.Services.JobOrders.API.Models.CreateJobOrderContactRoleRequest": {
"required": [
"contactId",
"contactRoleId"
],
"type": "object",
"properties": {
"contactId": {
"type": "integer",
"description": "The Id of the Contact to assigned to the role. A list of Contacts can be found at the customer/contacts endpoint\r\nfor the customer the Job Order belongs to.",
"format": "int32"
},
"contactRoleId": {
"type": "integer",
"description": "Valid Contact Roles can be found in the Contact Roles Datalist.",
"format": "int32"
}
},
"additionalProperties": false,
"description": "A request to assign a Contact a role for the Job Order."
},
"TwApi.Services.JobOrders.API.Models.CreateJobOrderInterestCodeRequest": {
"required": [
"interestCodeId",
"isRequired"
],
"type": "object",
"properties": {
"interestCodeId": {
"type": "integer",
"description": "Valid Interest Codes can be found in the Interest Codes Datalist.",
"format": "int32"
},
"note": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "A place for notes about the interest code in respect to this specific job order.",
"nullable": true
},
"isRequired": {
"type": "boolean",
"description": "If true, employees are required to have the same interest code on their profile to be placed on assignment for this order."
}
},
"additionalProperties": false,
"description": "A request to add an interest code to a Job Order."
},
"TwApi.Services.JobOrders.API.Models.CreateJobOrderOfferRequest": {
"required": [
"assignmentRestrictionSessionId",
"employeeId"
],
"type": "object",
"properties": {
"employeeId": {
"type": "integer",
"description": "The Id of the Employee to be made an offer for. A list of Employees can be found at the search/employees endpoint.",
"format": "int64"
},
"assignmentRestrictionSessionId": {
"type": "string",
"description": "Assignment Restriction Sessions can be created with the Job Order > Create Assignment Restriction Session endpoint. All results from the session\r\nmust be approved before the employee can be made an offer.\r\nThe assignment restriction session must be for an assignment check because the employee endpoint\r\nwill be creating their assignment for them.",
"format": "uuid"
},
"assignmentStartDate": {
"type": "string",
"description": "An Assignment start date can be specified for the start date of the assignment when they are created upon an Employee accepting the job offer.\r\nThis is an optional parameter as the Assignment start date will default to using the Order's start date.",
"format": "date-time",
"nullable": true
},
"expirationDate": {
"type": "string",
"description": "A Job Offer will only be valid up until the specified Expiration Date. If no Expiration Date is provided, then the Job Offer will only be valid for as long as the associated Order is active.",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to add an Employee as a Candidate for the Job Order with a status of 'BuzzOffered'.\r\nIf the employee is already a candidate for this order, only their status will be changed.\r\nAdditionally, the employee will be sent a push notification notifying them of their offer."
},
"TwApi.Services.JobOrders.API.Models.CreateJobOrderRequest": {
"required": [
"customerId",
"jobOrderTypeId"
],
"type": "object",
"properties": {
"customerId": {
"type": "integer",
"description": "The Id of the Customer the Job Order will be created for. A list of customers can be found at the search/customers endpoint.",
"format": "int64"
},
"jobOrderTypeId": {
"type": "integer",
"description": "Valid Job Order Types can be found in the Order Types Datalist.",
"format": "int32"
},
"worksiteId": {
"type": "integer",
"description": "Worksite Id (optional). If not specified, the default worksite for the customer will be used.",
"format": "int32",
"nullable": true
},
"branchId": {
"type": "integer",
"description": "Brainch Id (optional). If not specified, the branch of the service rep or customer will be used, based off OrderBranchSource config type",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to create a Job Order."
},
"TwApi.Services.JobOrders.API.Models.CreateJobOrderRequiredDocumentTypeRequest": {
"required": [
"requiredDocumentTypeId"
],
"type": "object",
"properties": {
"requiredDocumentTypeId": {
"type": "integer",
"description": "The required document type identifier.",
"format": "int32"
}
},
"additionalProperties": false,
"description": "A request to add a Required Document type for a Job Order."
},
"TwApi.Services.JobOrders.API.Models.JobOrderAbsenceRequest": {
"required": [
"absenceEndDate",
"absenceStartDate",
"replacementForContactId"
],
"type": "object",
"properties": {
"replacementForContactId": {
"type": "integer",
"description": "Id for contact information of employee that is absent",
"format": "int32"
},
"requestedSubstituteEmployeeId": {
"type": "integer",
"description": "Id of employee requested as substitute",
"format": "int64",
"nullable": true
},
"absenceStartDate": {
"type": "string",
"description": "Start date for absence. (Date only)\r\nThe date format is ISO 8601 YYYY-MM-DD.",
"format": "date-time"
},
"absenceStartTime": {
"type": "string",
"description": "Start time for absence (Time only)",
"nullable": true
},
"absenceEndDate": {
"type": "string",
"description": "End date for absence. (Date only)\r\nThe date format is ISO 8601 YYYY-MM-DD.",
"format": "date-time"
},
"absenceEndTime": {
"type": "string",
"description": "End time for absence (Time only)",
"nullable": true
},
"absenceReasonId": {
"type": "string",
"description": "Id of reason given for absence. Absence reason must be specified on the same customer as the order.",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to create an absence record for the Job Order"
},
"TwApi.Services.JobOrders.API.Models.JobOrderVendorRequest": {
"required": [
"vendorCompanyId"
],
"type": "object",
"properties": {
"vendorCompanyId": {
"type": "integer",
"description": "Id of the Vendor Company",
"format": "int32"
},
"jobOrderCompanyStatus": {
"type": "string",
"description": "JobOrderCompany Status (A1, A2, D1, W1 etc)",
"nullable": true
},
"whenVisible": {
"type": "string",
"description": "The date and time after which the vendor will be able to see the Job Order and submit candidates. The timezone used is that of the database server.\r\n\r\n\r\nThe value will be ignored when the Vendor is configured on the Job Order's Customer as the settings on the customer supersede this value.",
"format": "date-time",
"nullable": true
},
"maximumCandidatesPerRequest": {
"maximum": 10000,
"minimum": 0,
"type": "integer",
"description": "Max number of candidates defined by the user",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": ""
},
"TwApi.Services.JobOrders.API.Models.SearchJobOrderCandidatesRequest": {
"required": [
"skip",
"take"
],
"type": "object",
"properties": {
"jobOrderCandidateStatusIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "If provided, searches for candidacies with a JobOrderCandidateStatusId that is included in the provided array.\r\nIf this parameter is null or an empty array, the results will not be filtered by status.",
"nullable": true
},
"orderBy": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.OrderByColumn"
},
"description": "Used to order the results by one or more of the returned columns.",
"nullable": true
},
"skip": {
"type": "integer",
"description": "The number of candidates to skip. Used for paging.",
"format": "int32"
},
"take": {
"type": "integer",
"description": "The number of candidates to return. Used for paging.",
"format": "int32"
},
"restrictToActiveCandidacies": {
"type": "boolean",
"description": "If set to true only active candidates will be returned. If not set, both active and inactive candidates will be returned."
}
},
"additionalProperties": false,
"description": "A request containing parameters for the Job Order Candidates search"
},
"TwApi.Services.JobOrders.API.Models.SearchMultipleJobOrdersCandidatesRequest": {
"required": [
"skip",
"take"
],
"type": "object",
"properties": {
"statusActionDateAfter": {
"type": "string",
"description": "Optional. If specified, only candidacies with a StatusActionDate after this date will be returned.",
"format": "date-time",
"nullable": true
},
"statusActionDateBefore": {
"type": "string",
"description": "Optional. If specified, only candidacies with a StatusActionDate before this date will be returned.",
"format": "date-time",
"nullable": true
},
"jobOrderCandidateStatusIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "If provided, searches for candidacies with a JobOrderCandidateStatusId that is included in the provided array.\r\nIf this parameter is null or an empty array, the results will not be filtered by status.",
"nullable": true
},
"orderBy": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.OrderByColumn"
},
"description": "Used to order the results by one or more of the returned columns.",
"nullable": true
},
"skip": {
"type": "integer",
"description": "The number of candidates to skip. Used for paging.",
"format": "int32"
},
"take": {
"type": "integer",
"description": "The number of candidates to return. Used for paging.",
"format": "int32"
},
"restrictToActiveCandidacies": {
"type": "boolean",
"description": "If set to true only active candidates will be returned. If not set, both active and inactive candidates will be returned."
}
},
"additionalProperties": false,
"description": "A request containing parameters for the Candidates search across all Job Orders"
},
"TwApi.Services.JobOrders.API.Models.StageMassUpdateJobOrderFinancialsRequest": {
"required": [
"createNewAssignment",
"jobOrderUpdateTypeId",
"maintainMarkupPercentageOnPayrateChange",
"updateRatesTypeId"
],
"type": "object",
"properties": {
"assignmentIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "List of assignments to include in the update.",
"nullable": true
},
"jobOrderIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "List of job orders to include in the update.",
"nullable": true
},
"multiplierCodeId": {
"type": "integer",
"description": "When populated, all job orders and assignments will have their multiplier code changed to the provided value.",
"format": "int32",
"nullable": true
},
"updateRatesTypeId": {
"maximum": 3,
"minimum": 1,
"type": "integer",
"description": "When 1, then the pay rate and bill rate will be increased by the value supplied.\r\nWhen 2, then the pay rate and bill rate will be increased by the percentage supplied. Example: 20 would equal a 20 percent increase.\r\nWhen 3, then the pay rate and bill rate will be changed to the value supplied. In this instance, a supplied value of 0 on pay or bill rate will change the values to 0. Supply null for no change.",
"format": "int32"
},
"maintainMarkupPercentageOnPayrateChange": {
"type": "boolean",
"description": "When true and if only the pay rate is changed, then the bill rate will be recalculated based upon the markup percentage calculated from the current pay and bill rates."
},
"payRateChange": {
"type": "number",
"description": "The amount to change the pay rates on the assignments and job orders.",
"format": "double",
"nullable": true
},
"billRateChange": {
"type": "number",
"description": "The amount to change the bill rates on the assignments and job orders.",
"format": "double",
"nullable": true
},
"jobOrderUpdateTypeId": {
"type": "integer",
"description": "Determines the assignments that are automatically included based upon the supplied JobOrderIds.\r\n0 - Only update the supplied JobOrderIds. Use this as the default value.\r\n1 - Add all assignments of the supplied JobOrderIds.\r\n2 - Add all active assignments of the supplied JobOrderIds that will generate timecards on or after the ExecuteAsOfDate.",
"format": "int32"
},
"executeAsOfDate": {
"type": "string",
"description": "Optional override used to determine the current date used to determine active assignments for the supplied order Ids.\r\nIf null, UTC now will be assumed.",
"format": "date-time",
"nullable": true
},
"createNewAssignment": {
"type": "boolean",
"description": "If true, copy of the assignments will be created with the new rates. The old assignments will change status."
},
"createNewAssignmentStartDate": {
"type": "string",
"description": "The StartDate for the new assignments that will be created.",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false,
"description": "Request object to stage mass update on job orders and assignment"
},
"TwApi.Services.JobOrders.API.Models.UpdateJobOrderAdjustmentRequest": {
"required": [
"adjustmentId",
"payCodeId"
],
"type": "object",
"properties": {
"adjustmentId": {
"type": "integer",
"description": "The Id of the Adjustment that is added to the JobOrder.",
"format": "int32"
},
"payCodeId": {
"type": "integer",
"description": "The Id of the PayCode that is set when adding the Adjustment to the JobOrder.",
"format": "int32"
},
"defaultPayRate": {
"maximum": 99999999.9999,
"minimum": -99999999.9999,
"type": "number",
"description": "The PayRate.",
"format": "double",
"nullable": true
},
"defaultBillRate": {
"maximum": 99999999.9999,
"minimum": -99999999.9999,
"type": "number",
"description": "The BillRate.",
"format": "double",
"nullable": true
}
},
"additionalProperties": false,
"description": "The request model for updating a JobOrder Adjustment."
},
"TwApi.Services.JobOrders.API.Models.UpdateJobOrderCandidatePreferencesRequest": {
"type": "object",
"properties": {
"requiredSkills": {
"maxLength": 100,
"minLength": 0,
"type": "string",
"description": "Maps back to SpecialEd on OrderPerm. Required skills for the job order candidate preferences.",
"nullable": true
},
"additionalSkills": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "Additional skills for the job order candidate preferences.",
"nullable": true
},
"idealCandidateDescription": {
"maxLength": 1000,
"minLength": 0,
"type": "string",
"description": "Maps back to TypeofPerson on OrderPerm. Ideal Candidate for the job order candidate preferences.",
"nullable": true
},
"topKnockOutFactors": {
"maxLength": 500,
"minLength": 0,
"type": "string",
"description": "Maps back to SpecialRequest on OrderPerm. Knock-out Factors for the job order candidate preferences.",
"nullable": true
},
"topSuccessAttributesForRole": {
"maxLength": 1000,
"minLength": 0,
"type": "string",
"description": "Maps back to HotButtons on OrderPerm. Three most important attributes for success for the job order candidate preferences.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to update candidate preferences about the Job Order."
},
"TwApi.Services.JobOrders.API.Models.UpdateJobOrderCandidateRequest": {
"required": [
"jobOrderCandidateStatusId"
],
"type": "object",
"properties": {
"jobOrderCandidateStatusId": {
"type": "integer",
"description": "Valid values for JobOrderCandidateStatusId can be found in the Job Order Candidate Statuses Datalist.",
"format": "int32"
},
"comment": {
"maxLength": 1000,
"minLength": 0,
"type": "string",
"description": "A comment/notes field.",
"nullable": true
},
"rank": {
"type": "integer",
"description": "An optional rank field. There is no set way the system uses this so use it however best fits your organization.",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to update the information about a Job Order Candidate."
},
"TwApi.Services.JobOrders.API.Models.UpdateJobOrderCandidatesRequest": {
"required": [
"jobOrderCandidateIds",
"jobOrderCandidateStatusId"
],
"type": "object",
"properties": {
"jobOrderCandidateStatusId": {
"type": "integer",
"description": "The used to set the JobOrderCandidateStatusId.",
"format": "int32"
},
"jobOrderCandidateIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "A list of candidates id inline for updates."
},
"comment": {
"maxLength": 1000,
"minLength": 0,
"type": "string",
"description": "A comment/notes field.",
"nullable": true
},
"rank": {
"type": "integer",
"description": "An optional rank field. There is no set way the system uses this so use it however best fits your organization.",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to update a list Job Order Candidates."
},
"TwApi.Services.JobOrders.API.Models.UpdateJobOrderDirectHireFinancialsRequest": {
"required": [
"fee",
"salary"
],
"type": "object",
"properties": {
"salary": {
"maximum": 49999999.99,
"minimum": -49999999.99,
"type": "number",
"description": "The default base salary for assignments created for the job order.",
"format": "double"
},
"fee": {
"maximum": 49999999.99,
"minimum": -49999999.99,
"type": "number",
"description": "The default base fee for assignments created for the job order.",
"format": "double"
},
"feePercentage": {
"maximum": 9.99999999,
"minimum": -9.99999999,
"type": "number",
"description": "The default fee percentage for assignments created for the job order.",
"format": "double",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to update direct hire finacial information about the Job Order."
},
"TwApi.Services.JobOrders.API.Models.UpdateJobOrderFinancialsRequest": {
"required": [
"billRate",
"doubletimeBillRate",
"doubletimeFactor",
"doubletimePayRate",
"multiplierCodeId",
"overtimeBillRate",
"overtimeFactor",
"overtimePayRate",
"overtimePlanId",
"payPeriods",
"payRate",
"unitBillRate",
"unitPayRate",
"workerCompCodeId"
],
"type": "object",
"properties": {
"payRate": {
"type": "number",
"description": "The default base pay rate for assignments created for the job order.",
"format": "double"
},
"overtimePayRate": {
"type": "number",
"description": "The default overtime pay rate for assignments created for the job order.",
"format": "double"
},
"doubletimePayRate": {
"type": "number",
"description": "The default doubletime pay rate for assignments created for the job order.",
"format": "double"
},
"unitPayRate": {
"type": "number",
"description": "The default unit pay rate for assignments created for the order.",
"format": "double"
},
"billRate": {
"type": "number",
"description": "The default base bill rate for assignments created for the job order.",
"format": "double"
},
"overtimeBillRate": {
"type": "number",
"description": "The default overtime bill rate for assignments created for the job order.",
"format": "double"
},
"doubletimeBillRate": {
"type": "number",
"description": "The default doubletime bill rate for assignments created for the job order.",
"format": "double"
},
"unitBillRate": {
"type": "number",
"description": "The default unit bill rate for assignments created for the order.",
"format": "double"
},
"overtimeFactor": {
"type": "number",
"description": "Valid Overtime Factors can be found in the Overtime Factors Datalist.",
"format": "double"
},
"doubletimeFactor": {
"type": "number",
"description": "The number the base rate should be multiplied by to calculate the doubletime rate.",
"format": "double"
},
"payPeriods": {
"type": "integer",
"description": "Defines the number of pay periods in a year for this order (ex weekly pay would be 52).",
"format": "int32"
},
"multiplierCodeId": {
"type": "integer",
"description": "The specified Multiplier Code must be set up in customer defaults. See Customers > Get Default Multiplier Codes for a list of valid Multiplier Codes.",
"format": "int32"
},
"overtimePlanId": {
"type": "integer",
"description": "Valid Overtime Plans can be found in the Overtime Plans Datalist.",
"format": "int32"
},
"workerCompCodeId": {
"type": "integer",
"description": "The specified Worker Comp Code must be set up in customer defaults. See Customers > Get Worker Comp Codes for a list of valid Worker Comp Codes.",
"format": "int32"
},
"burdenTypeId": {
"type": "integer",
"description": "Valid Burden Types can be found in the Burden Types Datalist.",
"format": "int32",
"nullable": true
},
"rateSheetId": {
"type": "string",
"description": "The Rate Sheet associated with the Order",
"format": "uuid",
"nullable": true
},
"subsPayRate": {
"type": "number",
"description": "The default subs pay rate for assignments created for the job order.",
"format": "double",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to update default rates and other finacial information about the Job Order."
},
"TwApi.Services.JobOrders.API.Models.UpdateJobOrderInterestCodeRequest": {
"required": [
"interestCodeId",
"isRequired"
],
"type": "object",
"properties": {
"interestCodeId": {
"type": "integer",
"description": "Valid Interest Codes can be found in the Interest Codes Datalist.",
"format": "int32"
},
"note": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "A place for notes about the interest code in respect to this specific job order.",
"nullable": true
},
"isRequired": {
"type": "boolean",
"description": "If true, employees are required to have the same interest code on their profile to be placed on assignment for this order."
}
},
"additionalProperties": false,
"description": "A request to update an existing interest code already linked to the Job Order."
},
"TwApi.Services.JobOrders.API.Models.UpdateJobOrderInterestCodesRequest": {
"required": [
"interestCodes"
],
"type": "object",
"properties": {
"interestCodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.JobOrders.Service.Commands.InterestCodes.Models.JobOrderInterestCode"
},
"description": "The job order's updated interest codes"
}
},
"additionalProperties": false,
"description": "A request to update a Job Order's interest codes"
},
"TwApi.Services.JobOrders.API.Models.UpdateJobOrderJobBoardOptionsRequest": {
"type": "object",
"properties": {
"publicJobTitle": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "The public job title",
"nullable": true
},
"publicJobDescription": {
"type": "string",
"description": "The public job description",
"nullable": true
},
"publicJobDescriptionContentType": {
"type": "string",
"description": "The public job description content type\r\ni.e. text/html; charset=utf-8",
"nullable": true
},
"publicPostingDate": {
"type": "string",
"description": "The date the job order should be posted",
"format": "date-time",
"nullable": true
},
"doNotPostPublicly": {
"type": "boolean",
"description": "Indicates whether the job order should be posted publicly"
},
"publicEducationSummary": {
"type": "string",
"description": "The public education summary",
"nullable": true
},
"publicExperienceSummary": {
"type": "string",
"description": "The public experience summary",
"nullable": true
},
"showWorksiteAddress": {
"type": "boolean",
"description": "Indicates whether the worksite address should be posted in Job Board. The Job Board Config is ignored. The default value is false."
},
"showPayRate": {
"type": "boolean",
"description": "Indicates whether the pay rate should be posted in Job Board. The Job Board Config is ignored. The default value is false."
},
"localizedPublicJobDescriptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.LocalizedPublicJobDescription"
},
"description": "The localized job descriptions model.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to update Job Board options for a Job Order."
},
"TwApi.Services.JobOrders.API.Models.UpdateJobOrderRequiredDocumentTypeRequest": {
"required": [
"isActive",
"isRequired"
],
"type": "object",
"properties": {
"notes": {
"maxLength": 1000,
"minLength": 0,
"type": "string",
"description": "Notes for the job order required document type.",
"nullable": true
},
"isRequired": {
"type": "boolean",
"description": "Indicates if the job order required document type is required."
},
"isActive": {
"type": "boolean",
"description": "Indicates if the job order required document type is active."
}
},
"additionalProperties": false,
"description": "The update job order required document type request model."
},
"TwApi.Services.JobOrders.API.Models.UpsertJobOrderPositionSummaryRequest": {
"type": "object",
"properties": {
"primaryResponsibilities": {
"maxLength": 1000,
"minLength": 0,
"type": "string",
"description": "The Job Order Primary Responsibilities.\r\nMaps back to CompleteDetails on OrderPerm.",
"nullable": true
},
"salaryRange": {
"maxLength": 100,
"minLength": 0,
"type": "string",
"description": "The Job Order Salary Range.",
"nullable": true
},
"peopleWhoHaveSeenTheJobOrder": {
"maxLength": 100,
"minLength": 0,
"type": "string",
"description": "Job Order information about who have seen the job order.\r\nMaps back to Exclusive on OrderPerm.",
"nullable": true
},
"reasonForOpenPosition": {
"maxLength": 500,
"minLength": 0,
"type": "string",
"description": "The reason about the job order open position.\r\nMaps back to WhatsMissing on OrderPerm.",
"nullable": true
},
"jobBenefits": {
"maxLength": 1000,
"minLength": 0,
"type": "string",
"description": "The Job Order job benefits.",
"nullable": true
},
"interviewProcess": {
"maxLength": 150,
"minLength": 0,
"type": "string",
"description": "The Job order Interview Process.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to update or create a Job Order Position Summary."
},
"TwApi.Services.JobOrders.Service.Commands.Absence.CreateJobOrderAbsenceCommand.Result": {
"type": "object",
"properties": {
"absenceId": {
"type": "string",
"format": "uuid"
},
"jobOrderId": {
"type": "integer",
"format": "int64"
},
"replacementForContactId": {
"type": "integer",
"format": "int32"
},
"requestedSubstituteEmployeeId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"absenceStartDate": {
"type": "string",
"format": "date-time"
},
"absenceStartTime": {
"type": "string",
"nullable": true
},
"absenceEndDate": {
"type": "string",
"format": "date-time"
},
"absenceEndTime": {
"type": "string",
"nullable": true
},
"absenceReasonId": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.JobOrders.Service.Commands.Absence.JobOrderAbsenceQuery.Result": {
"type": "object",
"properties": {
"absenceId": {
"type": "string",
"format": "uuid"
},
"jobOrderId": {
"type": "integer",
"format": "int64"
},
"replacementForContactId": {
"type": "integer",
"format": "int32"
},
"requestedSubstituteEmployeeId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"absenceStartDate": {
"type": "string",
"format": "date-time"
},
"absenceStartTime": {
"type": "string",
"nullable": true
},
"absenceEndDate": {
"type": "string",
"format": "date-time"
},
"absenceEndTime": {
"type": "string",
"nullable": true
},
"absenceReasonId": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.JobOrders.Service.Commands.Adjustments.CreateJobOrderAdjustment.Result": {
"type": "object",
"properties": {
"jobOrderAdjustmentId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.JobOrders.Service.Commands.Adjustments.JobOrderAdjustments.Result": {
"type": "object",
"properties": {
"jobOrderAdjustmentId": {
"type": "integer",
"format": "int32"
},
"adjustmentId": {
"type": "integer",
"format": "int32"
},
"adjustment": {
"type": "string",
"nullable": true
},
"defaultPayRate": {
"type": "number",
"format": "double"
},
"defaultBillRate": {
"type": "number",
"format": "double"
},
"payCode": {
"type": "string",
"nullable": true
},
"payCodeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"assignmentsUsedCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.JobOrders.Service.Commands.AssignmentRestriction.AssignmentRestrictionSessionQuery.Result": {
"type": "object",
"properties": {
"assignmentRestrictionSessionId": {
"type": "string",
"format": "uuid"
},
"jobOrderId": {
"type": "integer",
"format": "int64"
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"isCandidateCheck": {
"type": "boolean"
},
"assignmentStartDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"dateCreated": {
"type": "string",
"format": "date-time"
},
"dateLastProcessed": {
"type": "string",
"format": "date-time",
"nullable": true
},
"isComplete": {
"type": "boolean"
},
"dateCompleted": {
"type": "string",
"format": "date-time",
"nullable": true
},
"completedByServiceRepId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"completedByServiceRep": {
"type": "string",
"nullable": true
},
"resultingAssignmentId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"resultingJobOrderCandidateId": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.JobOrders.Service.Commands.AssignmentRestriction.AssignmentRestrictionSessionResultsQuery.Result": {
"type": "object",
"properties": {
"assignmentRestrictionResultId": {
"type": "integer",
"format": "int64"
},
"originTypeId": {
"$ref": "#/components/schemas/TwApi.Common.Enums.OriginType"
},
"originId": {
"type": "integer",
"format": "int64"
},
"friendlyOriginName": {
"type": "string",
"nullable": true
},
"canBeApproved": {
"type": "boolean"
},
"errorMessage": {
"type": "string",
"nullable": true
},
"formId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"isApproved": {
"type": "boolean"
},
"approvedByServiceRepId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"approvedByServiceRep": {
"type": "string",
"nullable": true
},
"approvedDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.JobOrders.Service.Commands.AssignmentRestriction.CreateAssignmentRestrictionSessionCommand.Result": {
"type": "object",
"properties": {
"assignmentRestrictionSessionId": {
"type": "string",
"format": "uuid"
},
"canCreateUsingSessionId": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.JobOrders.Service.Commands.AssignmentRestriction.GenerateAssignmentRestrictionsCommand.Result": {
"type": "object",
"properties": {
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.JobOrders.Service.Commands.CopyJobOrderCommand.Result": {
"type": "object",
"properties": {
"jobOrderId": {
"type": "integer",
"format": "int64"
}
},
"additionalProperties": false
},
"TwApi.Services.JobOrders.Service.Commands.CreateJobOrderCandidateCommand.Result": {
"type": "object",
"properties": {
"jobOrderCandidateId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.JobOrders.Service.Commands.CreateJobOrderCommand.Result": {
"type": "object",
"properties": {
"orderId": {
"type": "integer",
"format": "int64"
}
},
"additionalProperties": false
},
"TwApi.Services.JobOrders.Service.Commands.CreateJobOrderContactRoleCommand.Result": {
"type": "object",
"properties": {
"jobOrderContactRoleId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.JobOrders.Service.Commands.CreateJobOrderOfferCommand.Result": {
"type": "object",
"properties": {
"jobOrderCandidateId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.JobOrders.Service.Commands.CreateJobOrderRequiredDocumentType.Result": {
"type": "object",
"properties": {
"orderRequiredDocumentTypeId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.JobOrders.Service.Commands.InterestCodes.CreateJobOrderInterestCodeCommand.Result": {
"type": "object",
"properties": {
"jobOrderInterestCodeId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.JobOrders.Service.Commands.InterestCodes.JobOrderInterestCodesQuery.Result": {
"type": "object",
"properties": {
"jobOrderInterestCodeId": {
"type": "integer",
"format": "int32"
},
"jobOrderInterestCodeGuid": {
"type": "string",
"format": "uuid"
},
"interestCodeId": {
"type": "integer",
"format": "int32"
},
"interestCode": {
"type": "string",
"nullable": true
},
"note": {
"type": "string",
"nullable": true
},
"isRequired": {
"type": "boolean"
},
"subCategoryId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"subCategory": {
"type": "string",
"nullable": true
},
"dateCreated": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"TwApi.Services.JobOrders.Service.Commands.InterestCodes.Models.JobOrderInterestCode": {
"type": "object",
"properties": {
"interestCodeId": {
"type": "integer",
"format": "int32"
},
"note": {
"type": "string",
"nullable": true
},
"isRequired": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.JobOrders.Service.Commands.JobOrderCandidatePreferences.Result": {
"type": "object",
"properties": {
"jobOrderId": {
"type": "integer",
"format": "int64"
},
"requiredSkills": {
"type": "string",
"nullable": true
},
"additionalSkills": {
"type": "string",
"nullable": true
},
"idealCandidateDescription": {
"type": "string",
"nullable": true
},
"topKnockOutFactors": {
"type": "string",
"nullable": true
},
"topSuccessAttributesForRole": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.JobOrders.Service.Commands.JobOrderCandidatesQuery.Result": {
"type": "object",
"properties": {
"jobOrderCandidateId": {
"type": "integer",
"format": "int64"
},
"jobOrderCandidateGuid": {
"type": "string",
"format": "uuid"
},
"jobOrderCandidateStatusId": {
"type": "integer",
"format": "int32"
},
"jobOrderCandidateStatus": {
"type": "string",
"nullable": true
},
"isActiveCandidate": {
"type": "boolean"
},
"statusActionDate": {
"type": "string",
"format": "date-time"
},
"rank": {
"type": "integer",
"format": "int32",
"nullable": true
},
"comment": {
"type": "string",
"nullable": true
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"branchId": {
"type": "integer",
"format": "int32"
},
"branchName": {
"type": "string",
"nullable": true
},
"isAssigned": {
"type": "boolean"
},
"primaryPhoneNumberContactMethodId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"primaryPhoneNumber": {
"type": "string",
"nullable": true
},
"primaryPhoneNumberCountryCallingCode": {
"type": "integer",
"format": "int32",
"nullable": true
},
"primaryEmailAddressContactMethodId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"primaryEmailAddress": {
"type": "string",
"nullable": true
},
"emailAddress": {
"type": "string",
"nullable": true
},
"expirationDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"interestCodeMatchPercentage": {
"type": "number",
"format": "double"
},
"resumeDocumentId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"submittedBy": {
"type": "string",
"nullable": true
},
"companyId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"companyName": {
"type": "string",
"nullable": true
},
"companyIsVendor": {
"type": "boolean",
"nullable": true
},
"dateJobReceiptEmailQueued": {
"type": "string",
"format": "date-time",
"nullable": true
},
"jobReceiptEmailQueuedSuccessfully": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.JobOrders.Service.Commands.JobOrderCandidatesSummary.Result": {
"type": "object",
"properties": {
"candidateStatusId": {
"type": "integer",
"format": "int32"
},
"candidateStatus": {
"type": "string",
"nullable": true
},
"numberOfCandidates": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.JobOrders.Service.Commands.JobOrderContactsQuery.Result": {
"type": "object",
"properties": {
"jobOrderContactRoleId": {
"type": "integer",
"format": "int32"
},
"jobOrderContactRoleGuid": {
"type": "string",
"format": "uuid"
},
"contactId": {
"type": "integer",
"format": "int32"
},
"contactRoleId": {
"type": "integer",
"format": "int32"
},
"contactRole": {
"type": "string",
"nullable": true
},
"officePhoneCountryCallingCode": {
"type": "integer",
"format": "int32",
"nullable": true
},
"officePhone": {
"type": "string",
"nullable": true
},
"emailAddress": {
"type": "string",
"nullable": true
},
"branch": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.JobOrders.Service.Commands.JobOrderDirectHireFinancials.Result": {
"type": "object",
"properties": {
"jobOrderId": {
"type": "integer",
"format": "int64"
},
"salary": {
"type": "number",
"format": "double"
},
"fee": {
"type": "number",
"format": "double"
},
"feePercentage": {
"type": "number",
"format": "double",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.JobOrders.Service.Commands.JobOrderExtendedDetailsQuery.Result": {
"type": "object",
"properties": {
"jobOrderId": {
"type": "integer",
"format": "int64"
},
"purchaseOrderId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"purchaseOrderValue": {
"type": "number",
"format": "double",
"nullable": true
},
"purchaseOrderEndDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"purchaseOrderNumber": {
"type": "string",
"nullable": true
},
"location": {
"type": "string",
"nullable": true
},
"mileageRate": {
"type": "number",
"format": "double",
"nullable": true
},
"costCenter": {
"type": "string",
"nullable": true
},
"subEntity": {
"type": "string",
"nullable": true
},
"accountCode": {
"type": "string",
"nullable": true
},
"customerSkill": {
"type": "string",
"nullable": true
},
"checkDelivery": {
"type": "string",
"nullable": true
},
"requisitionNumber": {
"type": "string",
"nullable": true
},
"alternateRequisitionNumber": {
"type": "string",
"nullable": true
},
"requisitionEndDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"customerExtra1": {
"type": "string",
"nullable": true
},
"customerExtra2": {
"type": "string",
"nullable": true
},
"customerExtra3": {
"type": "string",
"nullable": true
},
"payrollNote": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.JobOrders.Service.Commands.JobOrderFinancialDetailsQuery.Result": {
"type": "object",
"properties": {
"payRate": {
"type": "number",
"format": "double"
},
"overtimePayRate": {
"type": "number",
"format": "double"
},
"doubletimePayRate": {
"type": "number",
"format": "double"
},
"unitPayRate": {
"type": "number",
"format": "double"
},
"billRate": {
"type": "number",
"format": "double"
},
"overtimeBillRate": {
"type": "number",
"format": "double"
},
"doubletimeBillRate": {
"type": "number",
"format": "double"
},
"unitBillRate": {
"type": "number",
"format": "double"
},
"overtimeFactor": {
"type": "number",
"format": "double",
"nullable": true
},
"doubletimeFactor": {
"type": "number",
"format": "double"
},
"payPeriods": {
"type": "integer",
"format": "int32"
},
"multiplierCodeId": {
"type": "integer",
"format": "int32"
},
"multiplierCode": {
"type": "string",
"nullable": true
},
"overtimePlanId": {
"type": "integer",
"format": "int32"
},
"overtimePlan": {
"type": "string",
"nullable": true
},
"gpPercent": {
"type": "number",
"format": "double",
"nullable": true
},
"desiredGmPercent": {
"type": "number",
"format": "double",
"nullable": true
},
"gpEstimate": {
"type": "number",
"format": "double",
"nullable": true
},
"workerCompCodeId": {
"type": "integer",
"format": "int32"
},
"workerCompCode": {
"type": "string",
"nullable": true
},
"burdenTypeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"burdenType": {
"type": "string",
"nullable": true
},
"rateSheetId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"sutaJurisId": {
"type": "integer",
"format": "int32"
},
"sutaJuris": {
"type": "string",
"nullable": true
},
"burdenRate": {
"type": "number",
"format": "double"
},
"impliesActive": {
"type": "boolean"
},
"subsPayRate": {
"type": "number",
"format": "double",
"nullable": true
},
"orderRootGuid": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"TwApi.Services.JobOrders.Service.Commands.JobOrderJobBoardDetails.Result": {
"type": "object",
"properties": {
"jobOrderId": {
"type": "integer",
"format": "int64"
},
"orderId": {
"type": "integer",
"format": "int64",
"deprecated": true
},
"dateOrderTaken": {
"type": "string",
"format": "date-time",
"nullable": true
},
"jobDescription": {
"type": "string",
"nullable": true
},
"jobDescriptionContentType": {
"type": "string",
"nullable": true
},
"jobTitle": {
"type": "string",
"nullable": true
},
"category": {
"type": "string",
"nullable": true
},
"jobOrderType": {
"type": "string",
"nullable": true
},
"skills": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"featured": {
"type": "boolean",
"nullable": true
},
"pay": {
"type": "number",
"format": "double",
"nullable": true
},
"payFrequency": {
"type": "string",
"nullable": true
},
"payMin": {
"type": "number",
"format": "double",
"nullable": true
},
"payMax": {
"type": "number",
"format": "double",
"nullable": true
},
"payCurrency": {
"type": "string",
"nullable": true
},
"branchId": {
"type": "integer",
"format": "int32"
},
"branchName": {
"type": "string",
"nullable": true
},
"jobBoardUrl": {
"type": "string",
"nullable": true,
"deprecated": true
},
"educationSummary": {
"type": "string",
"nullable": true
},
"experienceSummary": {
"type": "string",
"nullable": true
},
"publishDateTime": {
"type": "string",
"format": "date-time",
"nullable": true
},
"address": {
"$ref": "#/components/schemas/TempWorks.TwApi.Common.Models.Address"
},
"jobOrderJobBoardGuid": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"TwApi.Services.JobOrders.Service.Commands.JobOrderMatchingRateSheets.Result": {
"type": "object",
"properties": {
"matchingRateSheets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.RateSheets.Service.Commands.GetRateSheetMatchList.Result"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.JobOrders.Service.Commands.JobOrderPositionSummary.Result": {
"type": "object",
"properties": {
"jobOrderId": {
"type": "integer",
"format": "int64"
},
"primaryResponsibilities": {
"type": "string",
"nullable": true
},
"salaryRange": {
"type": "string",
"nullable": true
},
"peopleWhoHaveSeenTheJobOrder": {
"type": "string",
"nullable": true
},
"reasonForOpenPosition": {
"type": "string",
"nullable": true
},
"jobBenefits": {
"type": "string",
"nullable": true
},
"interviewProcess": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.JobOrders.Service.Commands.JobOrderRequiredDocumentTypes.Result": {
"type": "object",
"properties": {
"jobOrderId": {
"type": "integer",
"format": "int64"
},
"orderRequiredDocumentTypeId": {
"type": "integer",
"format": "int32"
},
"requiredDocumentTypeId": {
"type": "integer",
"format": "int32"
},
"requiredDocumentType": {
"type": "string",
"nullable": true
},
"requiredDocumentCategoryId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"requiredDocumentCategory": {
"type": "string",
"nullable": true
},
"notes": {
"type": "string",
"nullable": true
},
"isRequired": {
"type": "boolean"
},
"isActive": {
"type": "boolean"
},
"daysWarningBeforeExpire": {
"type": "integer",
"format": "int32"
},
"requiredDocumentAuthorityId": {
"type": "integer",
"format": "int32"
},
"requiredDocumentAuthority": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.JobOrders.Service.Commands.JobOrderScheduleQuery.Result": {
"type": "object",
"properties": {
"isScheduledForSunday": {
"type": "boolean"
},
"isScheduledForMonday": {
"type": "boolean"
},
"isScheduledForTuesday": {
"type": "boolean"
},
"isScheduledForWednesday": {
"type": "boolean"
},
"isScheduledForThursday": {
"type": "boolean"
},
"isScheduledForFriday": {
"type": "boolean"
},
"isScheduledForSaturday": {
"type": "boolean"
},
"startDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"estimatedEndDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"shiftId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"shift": {
"type": "string",
"nullable": true
},
"shiftNotes": {
"type": "string",
"nullable": true
},
"startTime": {
"type": "string",
"nullable": true
},
"endTime": {
"type": "string",
"nullable": true
},
"jobOrderDurationId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"jobOrderDuration": {
"type": "string",
"nullable": true
},
"jobOrderShiftNotes": {
"type": "string",
"nullable": true
},
"localizedJobOrderSchedule": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TempWorks.TwApi.Common.Models.LocalizedJobOrderSchedule"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.JobOrders.Service.Commands.JobOrderStatusUpdateCommand.Result": {
"type": "object",
"properties": {
"statusChanged": {
"type": "boolean"
},
"additionalActionMessages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.StatusChange.AdditionalActionMessage"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.JobOrders.Service.Commands.JobOrderSummaryQuery.Result": {
"type": "object",
"properties": {
"branchId": {
"type": "integer",
"format": "int32"
},
"branch": {
"type": "string",
"nullable": true
},
"jobOrderStatusId": {
"type": "integer",
"format": "int32"
},
"jobOrderStatus": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"positionsRequired": {
"type": "integer",
"format": "int32"
},
"positionsFilled": {
"type": "integer",
"format": "int32"
},
"customerId": {
"type": "integer",
"format": "int64"
},
"customerName": {
"type": "string",
"nullable": true
},
"departmentName": {
"type": "string",
"nullable": true
},
"jobTitleId": {
"type": "integer",
"format": "int32"
},
"jobTitle": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.JobOrders.Service.Commands.JobOrderWorksiteDetailsQuery.Result": {
"type": "object",
"properties": {
"worksiteId": {
"type": "integer",
"format": "int32"
},
"worksiteName": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"customerId": {
"type": "integer",
"format": "int64"
},
"customerName": {
"type": "string",
"nullable": true
},
"departmentName": {
"type": "string",
"nullable": true
},
"address": {
"$ref": "#/components/schemas/TempWorks.TwApi.Common.Models.Address"
},
"directions": {
"type": "string",
"nullable": true
},
"dressCode": {
"type": "string",
"nullable": true
},
"timeClockTimeZoneId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"timeClockTimeZone": {
"type": "string",
"nullable": true
},
"isDaylightSavingsTimeObserved": {
"type": "boolean"
},
"isPublicTransportationAccessible": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.JobOrders.Service.Commands.MassUpdateFinancials.MassUpdateCalculationStatus.Result": {
"type": "object",
"properties": {
"isCalculationComplete": {
"type": "boolean"
},
"isUpdateComplete": {
"type": "boolean"
},
"isSessionInvalid": {
"type": "boolean"
},
"errorMessage": {
"type": "string",
"nullable": true
},
"excludedRecordsCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.JobOrders.Service.Commands.MassUpdateFinancials.MassUpdateJobOrderFinancialsMultiplierCodes.Result": {
"type": "object",
"properties": {
"multiplierCodeId": {
"type": "integer",
"format": "int32"
},
"multiplierCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.JobOrders.Service.Commands.MassUpdateFinancials.MassUpdateJobOrderFinancialsResults.CalculationResult": {
"type": "object",
"properties": {
"assignmentId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"jobOrderId": {
"type": "integer",
"format": "int64"
},
"multiplierCodeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"multiplierCode": {
"type": "string",
"nullable": true
},
"billRate": {
"type": "number",
"format": "double",
"nullable": true
},
"overtimeBillRate": {
"type": "number",
"format": "double",
"nullable": true
},
"doubletimeBillRate": {
"type": "number",
"format": "double",
"nullable": true
},
"payRate": {
"type": "number",
"format": "double",
"nullable": true
},
"overtimePayRate": {
"type": "number",
"format": "double",
"nullable": true
},
"doubletimePayRate": {
"type": "number",
"format": "double",
"nullable": true
},
"newMultiplierCodeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"newMultiplierCode": {
"type": "string",
"nullable": true
},
"newBillRate": {
"type": "number",
"format": "double",
"nullable": true
},
"newOvertimeBillRate": {
"type": "number",
"format": "double",
"nullable": true
},
"newDoubletimeBillRate": {
"type": "number",
"format": "double",
"nullable": true
},
"newPayRate": {
"type": "number",
"format": "double",
"nullable": true
},
"newOvertimePayRate": {
"type": "number",
"format": "double",
"nullable": true
},
"newDoubletimePayRate": {
"type": "number",
"format": "double",
"nullable": true
},
"validationErrors": {
"type": "string",
"nullable": true
},
"validationWarnings": {
"type": "string",
"nullable": true
},
"excludeFromUpdate": {
"type": "boolean"
},
"errorMessage": {
"type": "string",
"nullable": true
},
"isUpdateComplete": {
"type": "boolean"
},
"createNewAssignmentStartDate": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.JobOrders.Service.Commands.MassUpdateFinancials.StageMassUpdateFinancialsCalculation.Result": {
"type": "object",
"properties": {
"sessionId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"TwApi.Services.JobOrders.Service.Commands.MassUpdateFinancials.StageMassUpdateFinancialsOnJobOrderAndAsg.Result": {
"type": "object",
"properties": {
"sessionId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"TwApi.Services.JobOrders.Service.Commands.MultipleJobOrdersCandidatesQuery.Result": {
"type": "object",
"properties": {
"jobOrderId": {
"type": "integer",
"format": "int64"
},
"jobOrderCandidateId": {
"type": "integer",
"format": "int64"
},
"jobOrderCandidateStatusId": {
"type": "integer",
"format": "int32"
},
"jobOrderCandidateStatus": {
"type": "string",
"nullable": true
},
"isActiveCandidate": {
"type": "boolean"
},
"statusActionDate": {
"type": "string",
"format": "date-time"
},
"rank": {
"type": "integer",
"format": "int32",
"nullable": true
},
"comment": {
"type": "string",
"nullable": true
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"branchId": {
"type": "integer",
"format": "int32"
},
"branchName": {
"type": "string",
"nullable": true
},
"isAssigned": {
"type": "boolean"
},
"primaryPhoneNumberContactMethodId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"primaryPhoneNumber": {
"type": "string",
"nullable": true
},
"primaryPhoneNumberCountryCallingCode": {
"type": "integer",
"format": "int32",
"nullable": true
},
"primaryEmailAddressContactMethodId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"primaryEmailAddress": {
"type": "string",
"nullable": true
},
"expirationDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"interestCodeMatchPercentage": {
"type": "number",
"format": "double"
},
"resumeDocumentId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"submittedBy": {
"type": "string",
"nullable": true
},
"companyId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"companyName": {
"type": "string",
"nullable": true
},
"companyIsVendor": {
"type": "boolean",
"nullable": true
},
"customerName": {
"type": "string",
"nullable": true
},
"departmentName": {
"type": "string",
"nullable": true
},
"jobTitle": {
"type": "string",
"nullable": true
},
"orderType": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.JobOrders.Service.Commands.Vendors.JobOrderVendorsCreate.Result": {
"type": "object",
"properties": {
"jobOrderVendorId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.JobOrders.Service.Commands.Vendors.JobOrderVendorsList.Result": {
"type": "object",
"properties": {
"canEditWhenVisible": {
"type": "boolean"
},
"jobOrderVendorId": {
"type": "integer",
"format": "int32"
},
"vendorCompanyId": {
"type": "integer",
"format": "int32"
},
"vendorCompanyName": {
"type": "string",
"nullable": true
},
"companyIsVendor": {
"type": "boolean"
},
"jobOrderCompanyStatus": {
"type": "string",
"nullable": true
},
"jobOrderCompanyStatusDescription": {
"type": "string",
"nullable": true
},
"whenVisible": {
"type": "string",
"format": "date-time",
"nullable": true
},
"maximumCandidatesPerRequest": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Onboarding.API.Models.AddAdditionalPagesToStepInstanceRequest": {
"type": "object",
"properties": {
"additionalPageIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "A list of additional pages that should be added to the step. A list of valid workflows can be found at\r\nthe hrCenter/{productInstanceId}/pages endpoint.",
"nullable": true
},
"secondaryActorOriginId": {
"type": "integer",
"description": "The Id of the record that will be acting as a secondary actor for the workflow. This is required when assigning\r\npages that require a secondary actor to act first (i.e. recruiter first pages).",
"format": "int64",
"nullable": true
},
"secondaryActorOriginTypeId": {
"type": "integer",
"description": "The type of record that will be acting as a secondary actor for the workflow. This is required when assigning\r\npages that require a secondary actor to act first (i.e. recruiter first pages).",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to add additional pages to an existing Workflow Step."
},
"TwApi.Services.Onboarding.API.Models.AdvanceWorkflowRequest": {
"type": "object",
"properties": {
"secondaryActorOriginId": {
"type": "integer",
"description": "The Id of the record that will be acting as a secondary actor for the step",
"format": "int64",
"nullable": true
},
"secondaryActorOriginTypeId": {
"type": "integer",
"description": "The type of record that will be acting as a secondary actor for the step.",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to advance a workflow to the next step."
},
"TwApi.Services.Onboarding.API.Models.CreateWorkflowInstanceRequest": {
"required": [
"languageId",
"startingStepId",
"workflowId"
],
"type": "object",
"properties": {
"workflowId": {
"type": "integer",
"description": "The Id of the HRCenter workflow to be assigned. A list of valid workflows can be found at the\r\nhrCenter/{productInstanceId}/workflows endpoint.",
"format": "int32"
},
"startingStepId": {
"type": "integer",
"description": "The step in the workflow the user will begin at. A list of valid steps can be found at the\r\nhrCenter/{productInstanceId}/workflows/{workflowId}/steps endpoint.",
"format": "int32"
},
"languageId": {
"type": "integer",
"description": "The language the workflow should display and be filled out in. A list of valid languages can be found at the\r\nhrCenter/{productInstanceId}/languages endpoint.",
"format": "int32"
},
"additionalStartingStepPageIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "Any additional pages that should be added to the first step the user will begin filling out. A list of valid\r\nworkflows can be found at the hrCenter/{productInstanceId}/pages endpoint.",
"nullable": true
},
"secondaryActorOriginId": {
"type": "integer",
"description": "The Id of the record that will be acting as a secondary actor for the step",
"format": "int64",
"nullable": true
},
"secondaryActorOriginTypeId": {
"type": "integer",
"description": "The type of record that will be acting as a secondary actor for the step.",
"format": "int32",
"nullable": true
},
"additionalPrefillCriteria": {
"type": "object",
"additionalProperties": {
"type": "string",
"nullable": true
},
"description": "Additional parameters that will be passed to each of prefill procedures that run during the workflow",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to assign an Onboarding Workflow to an Employee."
},
"TwApi.Services.Onboarding.API.Models.JobOrderCandidatesRequest": {
"required": [
"orderIds"
],
"type": "object",
"properties": {
"orderIds": {
"minItems": 1,
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "Array of JobOrderIds to add the applicant to."
},
"utM_Source": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "Optional field to track where the order candidate originated from.",
"nullable": true
},
"utM_Medium": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "Optional field to track type of link the order candidate used.",
"nullable": true
},
"utM_Campaign": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "Optional field to track specific marketing campaign",
"nullable": true
}
},
"additionalProperties": false,
"description": "Request body for adding an onboarding employee as a job order candidate"
},
"TwApi.Services.Onboarding.API.Models.LogUserWorkflowUpdatedRequest": {
"required": [
"workflowId",
"workflowName"
],
"type": "object",
"properties": {
"workflowId": {
"type": "integer",
"description": "The Id of the workflow",
"format": "int32"
},
"workflowName": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "Name of the workflow"
},
"completed": {
"type": "boolean",
"description": "Indicates if the workflow if completed"
},
"dateCreated": {
"type": "string",
"description": "Date Created",
"format": "date-time"
},
"dateCompleted": {
"type": "string",
"description": "Date Completed",
"format": "date-time",
"nullable": true
},
"dateRejected": {
"type": "string",
"description": "Date Rejected",
"format": "date-time",
"nullable": true
},
"rejectionReason": {
"type": "string",
"description": "Rejection Reason",
"nullable": true
},
"rejectedBy": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "Name of the user who rejected the workflow",
"nullable": true
},
"assignedBy": {
"$ref": "#/components/schemas/TwApi.Services.Onboarding.API.Models.UserRecord"
}
},
"additionalProperties": false,
"description": "Request body to log workflow progress"
},
"TwApi.Services.Onboarding.API.Models.PostfillRequest": {
"required": [
"currentActorUsername",
"postfillData",
"postfillProcedureName",
"tenantBlockId",
"tenantBlockName",
"tenantName",
"userBlockId"
],
"type": "object",
"properties": {
"tenantName": {
"minLength": 1,
"type": "string",
"description": "The HrCenter tenant name"
},
"tenantBlockName": {
"minLength": 1,
"type": "string",
"description": "The HrCenter Page Name"
},
"tenantBlockId": {
"type": "integer",
"description": "The HrCenter Page Id",
"format": "int32"
},
"userBlockId": {
"type": "integer",
"description": "The HrCenter User Page Id",
"format": "int32"
},
"postfillProcedureName": {
"minLength": 1,
"type": "string",
"description": "The name of the postfill procedure to run"
},
"postfillData": {
"minLength": 1,
"type": "string",
"description": "The postfill data in xml format."
},
"currentActorUsername": {
"minLength": 1,
"type": "string",
"description": "The current actor username"
},
"serviceRepName": {
"type": "string",
"description": "The name of the service rep running the service rep postfill procedure",
"nullable": true
}
},
"additionalProperties": false,
"description": "Request body to save postfill for a HrCenter page"
},
"TwApi.Services.Onboarding.API.Models.PrefillRequest": {
"required": [
"currentActorUsername",
"prefillProcedureName",
"tenantBlockId",
"tenantBlockName",
"tenantName",
"userBlockId"
],
"type": "object",
"properties": {
"tenantName": {
"minLength": 1,
"type": "string",
"description": "The HrCenter tenant name"
},
"tenantBlockName": {
"minLength": 1,
"type": "string",
"description": "The HrCenter Page Name"
},
"tenantBlockId": {
"type": "integer",
"description": "The HrCenter Page Id",
"format": "int32"
},
"userBlockId": {
"type": "integer",
"description": "The HrCenter User Page Id",
"format": "int32"
},
"prefillProcedureName": {
"minLength": 1,
"type": "string",
"description": "The name of the prefill procedure to run"
},
"currentActorUsername": {
"minLength": 1,
"type": "string",
"description": "The current actor username"
},
"additionalPrefillCriteria": {
"type": "object",
"additionalProperties": {
"type": "string",
"nullable": true
},
"description": "Optional additional prefill criteria to provide to the sql prefill procedure.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Request body to get prefill for a HrCenter page"
},
"TwApi.Services.Onboarding.API.Models.RegisterApplicantRequest": {
"required": [
"branchId",
"firstName",
"howHeardOfId",
"lastName",
"password",
"productInstanceId",
"queryStringProcedureName",
"queryStringXml",
"username"
],
"type": "object",
"properties": {
"productInstanceId": {
"type": "string",
"description": "The Id of the HrCenter product instance the Applicant is applying too.",
"format": "uuid"
},
"username": {
"maxLength": 254,
"minLength": 0,
"type": "string",
"description": "The username the Applicant would like to use to login to HrCenter. A Validation error will \r\noccur if this username is already in use."
},
"password": {
"maxLength": 100,
"minLength": 7,
"type": "string",
"description": "The password for the Applicant's HrCenter account"
},
"firstName": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "The Applicant's first name."
},
"middleName": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Optional - The Applicant's middle name.",
"nullable": true
},
"lastName": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "The Applicant's last name."
},
"branchId": {
"type": "integer",
"description": "The Id of the Branch the Applicant is applying to",
"format": "int32"
},
"employmentCategoryId": {
"type": "string",
"description": "Optional - The desired Employment Category Guid of the applicant",
"format": "uuid",
"nullable": true
},
"lastFourCharsGovernmentId": {
"maxLength": 4,
"minLength": 4,
"type": "string",
"description": "Optional - Last Four Characters of the Applicant's last name. Is required when\r\nValidateGovIdAndLastNameComboDoesNotExist is set to true.",
"nullable": true
},
"governmentPersonalId": {
"maxLength": 10,
"minLength": 0,
"type": "string",
"description": "Optional - Government Personal Id of the Applicant",
"nullable": true
},
"primaryEmailAddress": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "The primary email address the Applicant should be contacted at.",
"nullable": true
},
"primaryPhoneNumber": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "The primary phone number the Applicant should be contacted at.",
"nullable": true
},
"primaryPhoneNumberCountryCallingCode": {
"type": "integer",
"description": "The country calling code the phone number will be associated with. This is required when the phone number is specified. \r\nValid country calling codes can be found in the CountryCallingCodes datalist.",
"format": "int32",
"nullable": true
},
"howHeardOfId": {
"type": "integer",
"description": "Optional - The value of how the Applicant heard about the Tenant they are applying to.\r\nValid HowHeardOfId's can be found in the HowHeardOf datalist.",
"format": "int32"
},
"howHeardOfDetail": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Optional - Additional information about how the Applicant heard about the Tenant.",
"nullable": true
},
"queryStringProcedureName": {
"maxLength": 254,
"minLength": 0,
"type": "string",
"description": "Optional - Custom procedure that runs after the Applicant profile is created."
},
"queryStringXml": {
"minLength": 1,
"type": "string",
"description": "Optional - The Xml string that is passed into the custom query string procedure."
},
"validateEmailDoesNotExist": {
"type": "boolean",
"description": "When set to true, a validation error will if the email address is already in use by an Employee under\r\nthis HrCenter product instance."
},
"validateGovIdAndLastNameComboDoesNotExist": {
"type": "boolean",
"description": "When set to true, a validation error will occur if the combination of the last four digits of the personal \r\ngovernment id and full last name would create a duplicate employee record under the this HrCenter product instance."
},
"utM_Source": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "Optional field to track where the applicant originated from.",
"nullable": true
},
"utM_Medium": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "Optional field to track type of link the applicant used.",
"nullable": true
},
"utM_Campaign": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "Optional field to track specific marketing campaign",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to create a new HrCenter Applicant profile"
},
"TwApi.Services.Onboarding.API.Models.RejectWorkflowRequest": {
"type": "object",
"properties": {
"rejectionReason": {
"type": "string",
"description": "An optional field to explain why the workflow as rejected.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to reject an onboarding workflow."
},
"TwApi.Services.Onboarding.API.Models.UserRecord": {
"required": [
"fullName",
"originId",
"originTypeId"
],
"type": "object",
"properties": {
"originId": {
"type": "integer",
"description": "OriginId of the actor who Assigned the UserWorkflow",
"format": "int64"
},
"originTypeId": {
"$ref": "#/components/schemas/TwApi.Common.Enums.OriginType"
},
"fullName": {
"minLength": 1,
"type": "string",
"description": "Fullname of the actor who Assigned the UserWorkflow"
}
},
"additionalProperties": false,
"description": "The actor who Assigned this UserWorkflow"
},
"TwApi.Services.Onboarding.Service.Commands.AdvanceWorkflowInstanceCommand.Result": {
"type": "object",
"properties": {
"stepInstanceId": {
"type": "string",
"format": "uuid"
},
"step": {
"type": "string",
"nullable": true
},
"stepId": {
"type": "integer",
"format": "int32"
},
"stepStatus": {
"type": "string",
"nullable": true
},
"currentActorUserId": {
"type": "string",
"nullable": true
},
"currentActorType": {
"$ref": "#/components/schemas/TwApi.Common.Enums.ActorType"
},
"currentActorOriginTypeId": {
"type": "integer",
"format": "int32"
},
"currentActorOriginId": {
"type": "integer",
"format": "int64",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Onboarding.Service.Commands.AssignWorkflowCommand.Result": {
"type": "object",
"properties": {
"responseMessage": {
"type": "string",
"nullable": true
},
"workflowInstanceId": {
"type": "string",
"format": "uuid"
},
"userStepId": {
"type": "string",
"format": "uuid"
},
"currentActorUserId": {
"type": "string",
"nullable": true
},
"currentActorType": {
"$ref": "#/components/schemas/TwApi.Common.Enums.ActorType"
},
"currentActorOriginTypeId": {
"type": "integer",
"format": "int32"
},
"currentActorOriginId": {
"type": "integer",
"format": "int64",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Onboarding.Service.Commands.ForceUserBlockCompleteCommand.Result": {
"type": "object",
"properties": {
"responseMessage": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Onboarding.Service.Commands.GetDocumentsToSignForStepQuery.Result": {
"type": "object",
"properties": {
"pageInstanceId": {
"type": "integer",
"format": "int32"
},
"page": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Onboarding.Service.Commands.GetEmployeeEeoSummary.Result": {
"type": "object",
"properties": {
"employeeId": {
"type": "integer",
"format": "int64"
},
"firstName": {
"type": "string",
"nullable": true
},
"middleName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"governmentPersonalId": {
"type": "string",
"nullable": true
},
"branchId": {
"type": "integer",
"format": "int32"
},
"branchName": {
"type": "string",
"nullable": true
},
"primaryPhoneNumberContactMethodId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"primaryPhoneNumber": {
"type": "string",
"nullable": true
},
"primaryPhoneNumberCountryCallingCode": {
"type": "integer",
"format": "int32",
"nullable": true
},
"cellPhoneNumberContactMethodId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"cellPhoneNumber": {
"type": "string",
"nullable": true
},
"cellPhoneNumberCountryCallingCode": {
"type": "integer",
"format": "int32",
"nullable": true
},
"primaryEmailAddressContactMethodId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"primaryEmailAddress": {
"type": "string",
"nullable": true
},
"extendedAddress": {
"$ref": "#/components/schemas/TempWorks.TwApi.Common.Models.ExtendedAddress"
},
"dateOfBirth": {
"type": "string",
"format": "date-time",
"nullable": true
},
"gender": {
"type": "string",
"nullable": true
},
"genderId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"nationality": {
"type": "string",
"nullable": true
},
"nationalityId": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Onboarding.Service.Commands.GetPageInstanceQuestionListQuery.Result": {
"type": "object",
"properties": {
"dataId": {
"type": "string",
"nullable": true
},
"question": {
"type": "string",
"nullable": true
},
"answer": {
"type": "string",
"nullable": true
},
"questionGroupId": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Onboarding.Service.Commands.GetPrefill.Result": {
"type": "object",
"properties": {
"prefillData": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Onboarding.Service.Commands.GetSecondaryWorkflowInstancesList.Result": {
"type": "object",
"properties": {
"workflowInstanceId": {
"type": "string",
"format": "uuid"
},
"workflowId": {
"type": "integer",
"format": "int32"
},
"workflow": {
"type": "string",
"nullable": true
},
"languageId": {
"type": "integer",
"format": "int32"
},
"dateCreated": {
"type": "string",
"format": "date-time",
"nullable": true
},
"dateCompleted": {
"type": "string",
"format": "date-time",
"nullable": true
},
"dateRejected": {
"type": "string",
"format": "date-time",
"nullable": true
},
"currentStepInstanceId": {
"type": "string",
"format": "uuid"
},
"currentStepId": {
"type": "integer",
"format": "int32"
},
"currentUserStep": {
"type": "string",
"nullable": true
},
"currentUserStepStatus": {
"type": "string",
"nullable": true
},
"currentActorUsername": {
"type": "string",
"nullable": true
},
"primaryActorUsername": {
"type": "string",
"nullable": true
},
"primaryActorType": {
"$ref": "#/components/schemas/TwApi.Common.Enums.ActorType"
}
},
"additionalProperties": false
},
"TwApi.Services.Onboarding.Service.Commands.GetSingleSignOnUrlCommand.Result": {
"type": "object",
"properties": {
"url": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Onboarding.Service.Commands.GetStepInstanceNextStepQuery.Result": {
"type": "object",
"properties": {
"stepId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"step": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Onboarding.Service.Commands.GetStepInstancePageInstanceListQuery.Result": {
"type": "object",
"properties": {
"pageInstanceId": {
"type": "integer",
"format": "int32"
},
"pageId": {
"type": "integer",
"format": "int32"
},
"page": {
"type": "string",
"nullable": true
},
"isComplete": {
"type": "boolean"
},
"pageOrder": {
"type": "integer",
"format": "int32"
},
"rejectedBy": {
"type": "string",
"nullable": true
},
"rejectedReason": {
"type": "string",
"nullable": true
},
"dateRejected": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Onboarding.Service.Commands.GetUrlForDocumentSigningQuery.Result": {
"type": "object",
"properties": {
"url": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Onboarding.Service.Commands.GetWorkflowInstanceListQuery.Result": {
"type": "object",
"properties": {
"workflowInstanceId": {
"type": "string",
"format": "uuid"
},
"workflowId": {
"type": "integer",
"format": "int32"
},
"workflow": {
"type": "string",
"nullable": true
},
"languageId": {
"type": "integer",
"format": "int32"
},
"dateCreated": {
"type": "string",
"format": "date-time"
},
"dateCompleted": {
"type": "string",
"format": "date-time",
"nullable": true
},
"dateRejected": {
"type": "string",
"format": "date-time",
"nullable": true
},
"rejectionReason": {
"type": "string",
"nullable": true
},
"assignedBy": {
"$ref": "#/components/schemas/TwApi.Services.HrCenter.Service.Client.Models.UserRecord"
},
"currentStepInstanceId": {
"type": "string",
"format": "uuid"
},
"currentUserStep": {
"type": "string",
"nullable": true
},
"currentUserStepStatus": {
"type": "string",
"nullable": true
},
"currentActorUsername": {
"type": "string",
"nullable": true
},
"currentActorOriginTypeId": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Onboarding.Service.Commands.GetWorkflowInstanceStepList.Result": {
"type": "object",
"properties": {
"stepInstanceId": {
"type": "string",
"format": "uuid"
},
"stepId": {
"type": "integer",
"format": "int32"
},
"step": {
"type": "string",
"nullable": true
},
"dateCreated": {
"type": "string",
"format": "date-time"
},
"dateStarted": {
"type": "string",
"format": "date-time",
"nullable": true
},
"dateSubmitted": {
"type": "string",
"format": "date-time",
"nullable": true
},
"dateCompleted": {
"type": "string",
"format": "date-time",
"nullable": true
},
"stepStatus": {
"type": "string",
"nullable": true
},
"stepOrder": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Onboarding.Service.Commands.PerformPostfill.Result": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"nullable": true
},
"setIndex": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Onboarding.Service.Commands.RegisterNewApplicantCommand.Result": {
"type": "object",
"properties": {
"employeeId": {
"type": "integer",
"format": "int64"
}
},
"additionalProperties": false
},
"TwApi.Services.Onboarding.Service.Commands.RejectUserBlockCommand.Result": {
"type": "object",
"properties": {
"responseMessage": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.API.Models.CreateDuplicateTimecardRequest": {
"type": "object",
"properties": {
"weekendDate": {
"type": "string",
"description": "Optional value used to override the weekend date of the new timecard.\r\nThe date format is ISO 8601 YYYY-MM-DD.",
"format": "date-time",
"nullable": true
},
"payCodeId": {
"type": "integer",
"description": "Optional value used to override the PayCode of the new timecard.",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": "Request object for Create Duplicate Timecard"
},
"TwApi.Services.Payroll.API.Models.CreateFundingRunRequest": {
"required": [
"paycardVendorId"
],
"type": "object",
"properties": {
"paycardVendorId": {
"type": "integer",
"description": "The paycard vendor the funding run will be processed for.",
"format": "int32"
},
"fundingAccount": {
"maxLength": 100,
"minLength": 0,
"type": "string",
"description": "The Funding account. This value is required and is the FundingAccount.AccountNumber when the paycard vendor Id is 4 (ADP).",
"nullable": true
},
"fundingAccountLocation": {
"maxLength": 100,
"minLength": 0,
"type": "string",
"description": "The ADP Funding Account Location. This value is required when the paycard vendor Id is 4 (ADP).",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request used ti initial a paycard funding run."
},
"TwApi.Services.Payroll.API.Models.CreatePaycardFundingRunMemberRequest": {
"required": [
"paycardCheckIds"
],
"type": "object",
"properties": {
"paycardCheckIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "A list of check ids to be added to the funding run."
}
},
"additionalProperties": false,
"description": "A request to add paycard checks to an existing funding run."
},
"TwApi.Services.Payroll.API.Models.CreateProofingSessionRequest": {
"required": [
"hierId",
"ownerServiceRepId",
"weekendBill"
],
"type": "object",
"properties": {
"sessionName": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "The proofing session name.",
"nullable": true
},
"ownerServiceRepId": {
"type": "integer",
"description": "The Id of the service rep for whom a session will be created.",
"format": "int32"
},
"hierId": {
"type": "integer",
"description": "The proofing session hierarchy id.",
"format": "int32"
},
"weekendBill": {
"type": "string",
"description": "The proofing session weekend bill.",
"format": "date-time"
}
},
"additionalProperties": false,
"description": "Request object used to define criteria for creating a proofing session."
},
"TwApi.Services.Payroll.API.Models.CreateTimecardAdjustmentRequest": {
"required": [
"adjustmentId",
"amountToBillPerUnit",
"amountToPayPerUnit",
"billAmount",
"payAmount",
"units"
],
"type": "object",
"properties": {
"adjustmentId": {
"type": "integer",
"format": "int32"
},
"payAmount": {
"type": "number",
"format": "double"
},
"billAmount": {
"type": "number",
"format": "double"
},
"units": {
"maximum": 2147483647,
"minimum": 0,
"type": "number",
"format": "double"
},
"amountToPayPerUnit": {
"type": "number",
"format": "double"
},
"amountToBillPerUnit": {
"type": "number",
"format": "double"
},
"invoiceText": {
"maxLength": 70,
"minLength": 0,
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.API.Models.CreateTimecardBatchRequest": {
"required": [
"timecards"
],
"type": "object",
"properties": {
"timecards": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.TimecardBatchInitialValues"
}
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.API.Models.CreateTimecardFromAssignmentRequest": {
"type": "object",
"properties": {
"assignmentId": {
"type": "integer",
"format": "int64"
},
"initialValues": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.TimecardInitialValuesRequest"
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.API.Models.CreateTimecardRequest": {
"type": "object",
"properties": {
"timecardGenerationType": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Enums.TimecardGenerationType"
},
"assignmentId": {
"type": "integer",
"description": "The assignment Id used to create timecards. This value can only be populated when the TimecardGenerationType is 3.",
"format": "int64",
"nullable": true
},
"weekId": {
"type": "integer",
"description": "Optional override for a specific week. Will default to the current open week if not supplied. This value can only be populated when the TimecardGenerationType is 0.",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": "Criteria for creation of Timecards."
},
"TwApi.Services.Payroll.API.Models.CreateTimecardsFromWeekRequest": {
"type": "object",
"properties": {
"weekId": {
"type": "integer",
"description": "Optional override for a specific week. Will default to the current open week if not supplied.",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": "Criteria for creation of Timecards for a given week."
},
"TwApi.Services.Payroll.API.Models.CreateWebCenterProofingSessionRequest": {
"type": "object",
"properties": {
"timecardIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "Optional list of timecardIds used to filter which timecards are pulled into a proofing run. All approved WebCenter timecards will be pulled into a proofing session if this value is null or has no items.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Request object used to define criteria for create WebCenter proofing session."
},
"TwApi.Services.Payroll.API.Models.CreateWebTimecardAdjustmentRequest": {
"required": [
"adjustmentId",
"amountToPayPerUnit",
"units"
],
"type": "object",
"properties": {
"adjustmentId": {
"type": "integer",
"description": "The Id of the adjustment. Valid values can be found at datalists/adjustments.",
"format": "int32"
},
"payAmount": {
"type": "number",
"description": "The total amount to pay the employee of the timecard.\r\nIf this value is not populated, it will be automatically calculated using the Units and AmountToPayPerUnit fields.",
"format": "double",
"nullable": true
},
"units": {
"maximum": 2147483647,
"minimum": 0,
"type": "number",
"description": "The number of units. The PayAmount must be equal to the AmountToPayPerUnit * Units when this value is not equal to 0.",
"format": "double"
},
"amountToPayPerUnit": {
"type": "number",
"description": "The amount to pay the employee per unit. \r\nThis value will may not be editable. The value of the adjustment can be found in the Web Timecard Adjustments Datalist.",
"format": "double"
}
},
"additionalProperties": false,
"description": "A request to create a timecard adjustment."
},
"TwApi.Services.Payroll.API.Models.CreateWebTimecardRequest": {
"required": [
"assignmentId",
"payCodeId"
],
"type": "object",
"properties": {
"assignmentId": {
"type": "integer",
"description": "The Id of the assignment used to create the web timecard.",
"format": "int64"
},
"costCenter": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "The cost center linked to the timecard. Valid values can be found in the Web Timecard Cost Centers Datalist.",
"nullable": true
},
"payCodeId": {
"type": "integer",
"description": "The pay code of the timecard. Valid values can be found in the Web Timecard Pay Codes Datalist.",
"format": "int32"
},
"weekendDate": {
"type": "string",
"description": "Week end date to be used for the time. This is the date of the customer's weekend day. \r\nTo get the correct value, use the Get Web Timecard Metadata for Assignment endpoint.",
"format": "date-time"
},
"customField1": {
"maxLength": 256,
"minLength": 0,
"type": "string",
"description": "User Defined Custom Field 1.\r\nThe display name for the field can be found on the Web Timecard Template Details using the WebTimecardTemplateId.",
"nullable": true
},
"customField2": {
"maxLength": 256,
"minLength": 0,
"type": "string",
"description": "User Defined Custom Field 2. \r\nThe display name for the field can be found on the Web Timecard Template Details using the WebTimecardTemplateId.",
"nullable": true
},
"comments": {
"maxLength": 4000,
"minLength": 0,
"type": "string",
"description": "The Comments on the Web Timecard. The comments may be edited by the employee, contact and service rep.",
"nullable": true
},
"dailyHours": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.DailyTime"
},
"description": "Optional value to include a specific days time. \r\nPopulated when the web timecard template type is Daily Total. Id: E148826E-6394-4575-9F91-FEE959AF8659",
"nullable": true
},
"fullFederalTime": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.DailyFederalTimecardTime"
},
"description": "Optional value to include a specific days time. \r\nPopulated when the web timecard template type is Federal Timecard Template. Id: DC9A37C9-6290-476F-9075-26C2143991F2",
"nullable": true
},
"weeklyHours": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.WeeklyTime"
},
"adjustments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateWebTimecardAdjustmentRequest"
},
"description": "Optional value to include adjustments for the Weekend Date.",
"nullable": true
},
"payRate": {
"type": "number",
"description": "Optional value to specify the pay rate for the timecard.\r\nIf left null, the pay rate on the assignment will be used.",
"format": "double",
"nullable": true
},
"overtimePayRate": {
"type": "number",
"description": "Optional value to specify the overtime pay rate for the timecard.\r\nIf left null, the overtime pay rate on the assignment will be used.",
"format": "double",
"nullable": true
},
"doubletimePayRate": {
"type": "number",
"description": "Optional value to specify the doubletime pay rate for the timecard.\r\nIf left null, the doubletime pay rate on the assignment will be used.",
"format": "double",
"nullable": true
}
},
"additionalProperties": false,
"description": "Request object used to create a web timecard."
},
"TwApi.Services.Payroll.API.Models.DailyFederalTimecardTime": {
"required": [
"date"
],
"type": "object",
"properties": {
"date": {
"type": "string",
"description": "The date of work.",
"format": "date-time"
},
"punchIn": {
"type": "string",
"description": "The time of punch in for the shift.",
"format": "date-span",
"nullable": true
},
"breakOneDurationInMinutes": {
"type": "integer",
"description": "The number of minutes for break 1.",
"format": "int32",
"nullable": true
},
"lunchOneOut": {
"type": "string",
"description": "The time of day for lunch out. \r\nThis value must be null when LunchOneDurationInMinutes is not null.",
"format": "date-span",
"nullable": true
},
"lunchOneIn": {
"type": "string",
"description": "The time of day for lunch in.\r\nThis value must be null when LunchOneInMinutes is not null.",
"format": "date-span",
"nullable": true
},
"lunchOneDurationInMinutes": {
"type": "integer",
"description": "Maps to Break3 in the Database.\r\nThis value must be null when LunchOneOut or LunchOneIn has a value.",
"format": "int32",
"nullable": true
},
"breakTwoDurationInMinutes": {
"type": "integer",
"description": "The number of minutes used for break 2.",
"format": "int32",
"nullable": true
},
"punchOut": {
"type": "string",
"description": "The time of day for the punch out.",
"format": "date-span",
"nullable": true
},
"shiftTwoPunchIn": {
"type": "string",
"description": "The time of day for the second shift punch In.",
"format": "date-span",
"nullable": true
},
"lunchTwoOut": {
"type": "string",
"description": "The time of day for the lunch 2 out. \r\nThis value must be null when LunchTwoDurationInMinutes is not null.",
"format": "date-span",
"nullable": true
},
"lunchTwoIn": {
"type": "string",
"description": "The time of day for the lunch 2 in. \r\nThis value must be null when LunchTwoInMinutes is not null.",
"format": "date-span",
"nullable": true
},
"lunchTwoDurationInMinutes": {
"type": "integer",
"description": "Maps to Break4 in the Database.\r\nThe number of minutes for lunch two. \r\nThis value must be null when LunchTwoOut or LunchTwoIn has a value.",
"format": "int32",
"nullable": true
},
"shiftTwoPunchOut": {
"type": "string",
"description": "The time of day for the second shift punch Out.",
"format": "date-span",
"nullable": true
}
},
"additionalProperties": false,
"description": "Object which contains the full federal details for a day of work."
},
"TwApi.Services.Payroll.API.Models.DailyTime": {
"required": [
"date"
],
"type": "object",
"properties": {
"date": {
"type": "string",
"description": "The date of work.",
"format": "date-time"
},
"totalHours": {
"maximum": 2147483647,
"minimum": 0,
"type": "number",
"description": "The total hours worked in the day.",
"format": "double",
"nullable": true
}
},
"additionalProperties": false,
"description": "Object which contains the details for daily work."
},
"TwApi.Services.Payroll.API.Models.MoveTimecardsRequest": {
"required": [
"timecardIds"
],
"type": "object",
"properties": {
"sessionId": {
"type": "integer",
"description": "The id of the proofing session that the timecards will be moved to.",
"format": "int32"
},
"timecardIds": {
"minItems": 1,
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "List of timecardIds used to filter which timecards are moved to a session."
}
},
"additionalProperties": false,
"description": "Request object used to define criteria for moving timecards to a session."
},
"TwApi.Services.Payroll.API.Models.PaycardEnrollmentRequest": {
"required": [
"employeeId",
"paycardVendorId"
],
"type": "object",
"properties": {
"paycardVendorId": {
"type": "integer",
"description": "The vendor of the paycard. A list of vendors may be found at the datalists/paycardVendors endpoint.",
"format": "int32"
},
"employeeId": {
"type": "integer",
"description": "The Employee Id to log the paycard activity to",
"format": "int64"
},
"fundingAccountId": {
"type": "string",
"description": "This is required when submitting a request for PaycardVendorId 4 (ADP).",
"nullable": true
},
"locationId": {
"type": "string",
"description": "This is required when submitting a request for PaycardVendorId 4 (ADP).",
"nullable": true
},
"paycardAccountId": {
"type": "string",
"description": "The Account identifier (number) for the Paycard.",
"nullable": true
},
"emailAddress": {
"type": "string",
"description": "Email address to tie to the paycard. This is optional when submitting a request for PaycardVendorId 4 (ADP).",
"nullable": true
},
"phone": {
"type": "string",
"description": "Phone of the employee. This is required and must be formatted as ###-###-#### or ########## when submitting a request for PaycardVendorId 4 (ADP).",
"nullable": true
},
"convertToACH": {
"type": "boolean",
"description": "The user choice to convert an existing ACH Bank Account to Rapid! Bank Account."
},
"standardizedAddress": {
"$ref": "#/components/schemas/TempWorks.TwApi.Common.Models.Address"
}
},
"additionalProperties": false,
"description": "A request to enroll an employee with a paycard vendor."
},
"TwApi.Services.Payroll.API.Models.TimecardBatchInitialValues": {
"required": [
"assignmentId",
"payCodeId",
"weekendDate"
],
"type": "object",
"properties": {
"assignmentId": {
"type": "integer",
"format": "int64"
},
"payCodeId": {
"type": "integer",
"format": "int32"
},
"weekendDate": {
"type": "string",
"format": "date-time"
},
"adjustments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.CreateTimecardAdjustmentRequest"
},
"nullable": true
},
"purchaseOrderId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"costCenter": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"nullable": true
},
"payrollNote": {
"maxLength": 500,
"minLength": 0,
"type": "string",
"nullable": true
},
"dateWorked": {
"type": "string",
"format": "date-time",
"nullable": true
},
"numberOfDaysWorked": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer",
"format": "int32",
"nullable": true
},
"payPeriodEndDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"payPeriodStartDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"regularHours": {
"maximum": 1000,
"minimum": -1000,
"type": "number",
"format": "double",
"nullable": true
},
"overtimeHours": {
"maximum": 1000,
"minimum": -1000,
"type": "number",
"format": "double",
"nullable": true
},
"doubletimeHours": {
"maximum": 1000,
"minimum": -1000,
"type": "number",
"format": "double",
"nullable": true
},
"day1TotalHours": {
"maximum": 24,
"minimum": -24,
"type": "number",
"format": "double",
"nullable": true
},
"day2TotalHours": {
"maximum": 24,
"minimum": -24,
"type": "number",
"format": "double",
"nullable": true
},
"day3TotalHours": {
"maximum": 24,
"minimum": -24,
"type": "number",
"format": "double",
"nullable": true
},
"day4TotalHours": {
"maximum": 24,
"minimum": -24,
"type": "number",
"format": "double",
"nullable": true
},
"day5TotalHours": {
"maximum": 24,
"minimum": -24,
"type": "number",
"format": "double",
"nullable": true
},
"day6TotalHours": {
"maximum": 24,
"minimum": -24,
"type": "number",
"format": "double",
"nullable": true
},
"day7TotalHours": {
"maximum": 24,
"minimum": -24,
"type": "number",
"format": "double",
"nullable": true
},
"units": {
"type": "number",
"format": "double",
"nullable": true
},
"isSalaryApproved": {
"type": "boolean",
"nullable": true
},
"oneTimeCalcOT": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.API.Models.TimecardInitialValuesRequest": {
"type": "object",
"properties": {
"payCodeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"purchaseOrderId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"costCenter": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"nullable": true
},
"payrollNote": {
"maxLength": 500,
"minLength": 0,
"type": "string",
"nullable": true
},
"weekendDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"dateWorked": {
"type": "string",
"format": "date-time",
"nullable": true
},
"numberOfDaysWorked": {
"maximum": 2147483647,
"minimum": 0,
"type": "integer",
"format": "int32",
"nullable": true
},
"payPeriodEndDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"payPeriodStartDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"regularHours": {
"maximum": 1000,
"minimum": -1000,
"type": "number",
"format": "double",
"nullable": true
},
"overtimeHours": {
"maximum": 1000,
"minimum": -1000,
"type": "number",
"format": "double",
"nullable": true
},
"doubletimeHours": {
"maximum": 1000,
"minimum": -1000,
"type": "number",
"format": "double",
"nullable": true
},
"day1TotalHours": {
"maximum": 24,
"minimum": -24,
"type": "number",
"format": "double",
"nullable": true
},
"day2TotalHours": {
"maximum": 24,
"minimum": -24,
"type": "number",
"format": "double",
"nullable": true
},
"day3TotalHours": {
"maximum": 24,
"minimum": -24,
"type": "number",
"format": "double",
"nullable": true
},
"day4TotalHours": {
"maximum": 24,
"minimum": -24,
"type": "number",
"format": "double",
"nullable": true
},
"day5TotalHours": {
"maximum": 24,
"minimum": -24,
"type": "number",
"format": "double",
"nullable": true
},
"day6TotalHours": {
"maximum": 24,
"minimum": -24,
"type": "number",
"format": "double",
"nullable": true
},
"day7TotalHours": {
"maximum": 24,
"minimum": -24,
"type": "number",
"format": "double",
"nullable": true
},
"units": {
"type": "number",
"format": "double",
"nullable": true
},
"isSalaryApproved": {
"type": "boolean",
"nullable": true
},
"oneTimeCalcOT": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.API.Models.UpdateTimecardAdjustmentRequest": {
"required": [
"adjustmentId",
"amountToBillPerUnit",
"amountToPayPerUnit",
"billAmount",
"payAmount",
"units"
],
"type": "object",
"properties": {
"adjustmentId": {
"type": "integer",
"format": "int32"
},
"payAmount": {
"type": "number",
"format": "double"
},
"billAmount": {
"type": "number",
"format": "double"
},
"units": {
"maximum": 2147483647,
"minimum": 0,
"type": "number",
"format": "double"
},
"amountToPayPerUnit": {
"type": "number",
"format": "double"
},
"amountToBillPerUnit": {
"type": "number",
"format": "double"
},
"invoiceText": {
"maxLength": 70,
"minLength": 0,
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.API.Models.UpdateWebTimecardAdjustmentRequest": {
"required": [
"adjustmentId",
"amountToPayPerUnit",
"units"
],
"type": "object",
"properties": {
"adjustmentId": {
"type": "integer",
"description": "The Id of the adjustment. Valid values can be found at datalists/adjustments.",
"format": "int32"
},
"payAmount": {
"type": "number",
"description": "The total amount to pay the employee of the timecard.\r\nIf this value is not populated, it will be automatically calculated using the Units and AmountToPayPerUnit fields.",
"format": "double",
"nullable": true
},
"units": {
"maximum": 2147483647,
"minimum": 0,
"type": "number",
"description": "The number of units. The PayAmount must be equal to the AmountToPayPerUnit * Units when this value is not equal to 0.",
"format": "double"
},
"amountToPayPerUnit": {
"type": "number",
"description": "The amount to pay the employee per unit. \r\nThis value will may not be editable. The value of the adjustment can be found in the Web Timecard Adjustments Datalist.",
"format": "double"
}
},
"additionalProperties": false,
"description": "A request to update the values on a timecard adjustment."
},
"TwApi.Services.Payroll.API.Models.UpdateWebTimecardRequest": {
"type": "object",
"properties": {
"comments": {
"maxLength": 4000,
"minLength": 0,
"type": "string",
"description": "The comments to log on the web timecard.\r\nShowNotes on the Web Timecard Template must be true to update comments.",
"nullable": true
},
"customField1": {
"maxLength": 256,
"minLength": 0,
"type": "string",
"description": "User Defined Custom Field 1.\r\nThe display name for the field can be found on the Web Timecard Template Details using the WebTimecardTemplateId.\r\nShowCustomField1 on the Web Timecard Template must be true to update CustomField1.",
"nullable": true
},
"customField2": {
"maxLength": 256,
"minLength": 0,
"type": "string",
"description": "User Defined Custom Field 2. \r\nThe display name for the field can be found on the Web Timecard Template Details using the WebTimecardTemplateId.\r\nShowCustomField2 on the Web Timecard Template must be true to update CustomField2.",
"nullable": true
},
"payRate": {
"type": "number",
"description": "The PayRate to update on the Web Timecard.\r\nIf value is not specified or null, then no changes will be made to the PayRate.\r\nShowPayRate on the Web Timecard Template must be true to update the PayRate.",
"format": "double",
"nullable": true
},
"overtimePayRate": {
"type": "number",
"description": "The OvertimePayRate to update on the Web Timecard.\r\nIf value is not specified or null, then no changes will be made to the OvertimePayRate.\r\nShowOvertimePayRate on the Web Timecard Template must be true to update the OvertimePayRate.",
"format": "double",
"nullable": true
},
"doubletimePayRate": {
"type": "number",
"description": "The DoubletimePayRate to update on the Web Timecard.\r\nIf value is not specified or null, then no changes will be made to the DoubletimePayRate.\r\nShowDoubletimePayRate on the Web Timecard Template must be true to update the DoubletimePayRate.",
"format": "double",
"nullable": true
},
"certified": {
"type": "boolean",
"description": "The Certified check box on the Web Timecard.\r\nWhen value is specified, a value for the custom data on the assignment associated with the timecard will be saved.\r\nAssignment Custom Data PropertyDefinitionId: '55C3AFE5-D9A4-4838-A337-7BD272D2645A'\r\nIf value is not specified or null, then no changes will be made to the Certified flag.\r\nShowCertified on the Web Timecard Template must be true to update the Certified flag.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Request object for updating the comments on a web timecard"
},
"TwApi.Services.Payroll.API.Models.UpdateWebTimecardTimeRequest": {
"type": "object",
"properties": {
"dailyHours": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.DailyTime"
},
"fullFederalTime": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.DailyFederalTimecardTime"
},
"weeklyHours": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.WeeklyTime"
}
},
"additionalProperties": false,
"description": "Request object for updating a WebTimecard"
},
"TwApi.Services.Payroll.API.Models.UpdateWebTimecardTimeRequestMobile": {
"type": "object",
"properties": {
"dailyHours": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.DailyTime"
},
"description": "Populated when the web timecard template type is Daily Total. \r\nId: E148826E-6394-4575-9F91-FEE959AF8659",
"nullable": true
},
"fullFederalTime": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.DailyFederalTimecardTime"
},
"weeklyHours": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.API.Models.WeeklyTime"
}
},
"additionalProperties": false,
"description": "Request object for updating a WebTimecard"
},
"TwApi.Services.Payroll.API.Models.ValidatePaycardAddressRequest": {
"required": [
"municipality",
"paycardVendorId",
"postalCode",
"region",
"street1"
],
"type": "object",
"properties": {
"paycardVendorId": {
"type": "integer",
"description": "The vendor of the paycard. A list of vendors may be found at the datalists/paycardVendors endpoint.",
"format": "int32"
},
"street1": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "This is the main street address. I.E. 1234 Main St."
},
"street2": {
"type": "string",
"description": "This is the secondary part of the address reserved for things such as identifying suite or apartment numbers.",
"nullable": true
},
"municipality": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "The city/municipality of the address."
},
"region": {
"maxLength": 2,
"minLength": 1,
"type": "string",
"description": "The state/region of the address."
},
"postalCode": {
"maxLength": 10,
"minLength": 1,
"type": "string",
"description": "The postal code of the address."
},
"countryCode": {
"type": "integer",
"description": "The country code identifying what country the address is in. A list of country codes can be found at the\r\ndatalists/countries endpoint.",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to validate the address for a paycard enrollment,"
},
"TwApi.Services.Payroll.API.Models.ValidatePaycardRequest": {
"required": [
"paycardVendorId"
],
"type": "object",
"properties": {
"paycardVendorId": {
"type": "integer",
"description": "The vendor of the paycard. A list of vendors may be found at the datalists/paycardVendors endpoint.",
"format": "int32"
},
"accountId": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "The account identifier for the paycard.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to validate the paycard account number with the vendor."
},
"TwApi.Services.Payroll.API.Models.WeeklyTime": {
"required": [
"doubletimeHours",
"overtimeHours",
"regularHours"
],
"type": "object",
"properties": {
"regularHours": {
"maximum": 2147483647,
"minimum": 0,
"type": "number",
"description": "Total Regular hours for the week.",
"format": "double"
},
"overtimeHours": {
"maximum": 2147483647,
"minimum": 0,
"type": "number",
"description": "Total Overtime hours for the week.",
"format": "double"
},
"doubletimeHours": {
"maximum": 2147483647,
"minimum": 0,
"type": "number",
"description": "Total Double time hours for the week.",
"format": "double"
}
},
"additionalProperties": false,
"description": "Object which contains the details for weekly totals."
},
"TwApi.Services.Payroll.Commands.CreateNewProofingSessionCommand.Result": {
"type": "object",
"properties": {
"proofingSessionId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Commands.EndProofingSession.Result": {
"type": "object",
"properties": {
"numberOfTimecardsProofed": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Commands.GetProofingSession.Result": {
"type": "object",
"properties": {
"hierId": {
"type": "integer",
"format": "int32"
},
"hierName": {
"type": "string",
"nullable": true
},
"hierTypeId": {
"type": "integer",
"format": "int32"
},
"hierTypeName": {
"type": "string",
"nullable": true
},
"sessionStatusID": {
"type": "string",
"format": "uuid"
},
"sessionOriginTypeID": {
"type": "string",
"format": "uuid"
},
"verifiedBy": {
"type": "string",
"nullable": true
},
"verifiedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"weekendBill": {
"type": "string",
"format": "date-time",
"nullable": true
},
"endedByServiceRepId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"serviceRepId": {
"type": "integer",
"format": "int32"
},
"serviceRepFullName": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Commands.GetProofingSessionTimecardsMetadata.Result": {
"type": "object",
"properties": {
"numberOfTotalTimecards": {
"type": "integer",
"format": "int32"
},
"totalRegularHours": {
"type": "number",
"format": "double"
},
"totalOvertimeHours": {
"type": "number",
"format": "double"
},
"totalDoubletimeHours": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.Datalists.EmployeeWebTimecardAdjustmentsForAssignment.Result": {
"type": "object",
"properties": {
"adjustmentId": {
"type": "integer",
"format": "int32"
},
"adjustment": {
"type": "string",
"nullable": true
},
"adjustmentDescription": {
"type": "string",
"nullable": true
},
"amountToPayPerUnit": {
"type": "number",
"format": "double"
},
"useUnits": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.Datalists.GetFundingPaycardVendors.Result": {
"type": "object",
"properties": {
"paycardVendorId": {
"type": "integer",
"format": "int32"
},
"paycardVendorName": {
"type": "string",
"nullable": true
},
"paycardNumberLength": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.Datalists.GetRapidFundingAccounts.Result": {
"type": "object",
"properties": {
"name": {
"type": "string",
"nullable": true
},
"id": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.Datalists.InvoiceHoldCodeList.Result": {
"type": "object",
"properties": {
"invoiceHoldCode": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.Datalists.PayHoldCodeList.Result": {
"type": "object",
"properties": {
"payHoldCode": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.Datalists.WebTimecardCostCentersForAssignment.Result": {
"type": "object",
"properties": {
"costCenter": {
"type": "string",
"nullable": true
},
"costCenterDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.Datalists.WebTimecardPaycodesForAssignment.Result": {
"type": "object",
"properties": {
"payCodeId": {
"type": "integer",
"format": "int32"
},
"payCode": {
"type": "string",
"nullable": true
},
"payCodeDescription": {
"type": "string",
"nullable": true
},
"isPaycodeAlreadyUsed": {
"type": "boolean"
},
"showCostCenters": {
"type": "boolean"
},
"hasOverrideTemplate": {
"type": "boolean"
},
"webTimecardTemplateId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"webTimecardTemplateTypeId": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.Datalists.WebTimecardStatusList.Result": {
"type": "object",
"properties": {
"webTimecardStatusId": {
"type": "integer",
"format": "int32"
},
"webTimecardStatus": {
"type": "string",
"nullable": true
},
"isLocked": {
"type": "boolean"
},
"isRejected": {
"type": "boolean"
},
"isApproved": {
"type": "boolean"
},
"isInPayroll": {
"type": "boolean"
},
"isCompleted": {
"type": "boolean"
},
"isOverride": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.Datalists.WebTimecardSuggestedCostCenters.Result": {
"type": "object",
"properties": {
"costCenter": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.PaycardChecks.PaycardChecksQuery.Result": {
"type": "object",
"properties": {
"paycardCheckId": {
"type": "integer",
"format": "int64"
},
"paycardVendorId": {
"type": "integer",
"format": "int32"
},
"paycardVendorName": {
"type": "string",
"nullable": true
},
"checkId": {
"type": "integer",
"format": "int64"
},
"payrollRunId": {
"type": "integer",
"format": "int32"
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"employeeBranchId": {
"type": "integer",
"format": "int32"
},
"employeeBranchName": {
"type": "string",
"nullable": true
},
"employerId": {
"type": "integer",
"format": "int32"
},
"payardFundingRunId": {
"type": "integer",
"format": "int64"
},
"dateFunded": {
"type": "string",
"format": "date-time",
"nullable": true
},
"amount": {
"type": "number",
"format": "double"
},
"hasError": {
"type": "boolean"
},
"lastErrorMessage": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.PaycardFundingRuns.CreatePaycardFundingRunCommand.Result": {
"type": "object",
"properties": {
"paycardFundingRunId": {
"type": "integer",
"format": "int64"
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.PaycardFundingRuns.CreatePaycardFundingRunMembersCommand.Result": {
"type": "object",
"properties": {
"fundingRunMemberId": {
"type": "integer",
"format": "int64"
},
"paycardCheckId": {
"type": "integer",
"format": "int64"
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.PaycardFundingRuns.PaycardFundingRunMembersQuery.Result": {
"type": "object",
"properties": {
"fundingRunMemberId": {
"type": "integer",
"format": "int64"
},
"paycardFundingRunId": {
"type": "integer",
"format": "int64"
},
"status": {
"type": "string",
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
},
"transactionId": {
"type": "string",
"nullable": true
},
"dateFunded": {
"type": "string",
"format": "date-time",
"nullable": true
},
"hasError": {
"type": "boolean"
},
"employeeBranchId": {
"type": "integer",
"format": "int32"
},
"employeeBranchName": {
"type": "string",
"nullable": true
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"lastName": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"amount": {
"type": "number",
"format": "double"
},
"payrollRunId": {
"type": "integer",
"format": "int32"
},
"checkId": {
"type": "integer",
"format": "int64"
},
"paycardCheckId": {
"type": "integer",
"format": "int64"
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.PaycardFundingRuns.PaycardFundingRunValidateMembersQuery.Result": {
"type": "object",
"properties": {
"fundingRunMemberId": {
"type": "integer",
"format": "int64"
},
"validationMessage": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.PaycardFundingRuns.PaycardFundingRunsQuery.Result": {
"type": "object",
"properties": {
"paycardFundingRunId": {
"type": "integer",
"format": "int64"
},
"status": {
"type": "string",
"nullable": true
},
"paycardVendorId": {
"type": "integer",
"format": "int32"
},
"paycardVendorName": {
"type": "string",
"nullable": true
},
"createdByServiceRepId": {
"type": "integer",
"format": "int32"
},
"createdByServiceRep": {
"type": "string",
"nullable": true
},
"dateCreated": {
"type": "string",
"format": "date-time"
},
"dateCancellationRequested": {
"type": "string",
"format": "date-time",
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
},
"paycardFundingJobId": {
"type": "string",
"nullable": true
},
"isComplete": {
"type": "boolean"
},
"hasError": {
"type": "boolean"
},
"totalFundingRunMembers": {
"type": "integer",
"format": "int32"
},
"numberProcessed": {
"type": "integer",
"format": "int32"
},
"numberOfErrors": {
"type": "integer",
"format": "int32"
},
"numberRemainingToProcess": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.Paycards.EnrollPaycard.Result": {
"type": "object",
"properties": {
"enrollmentId": {
"type": "string",
"nullable": true
},
"enrollmentStatus": {
"type": "string",
"nullable": true
},
"existingAccountFound": {
"type": "boolean"
},
"existingAccountNumber": {
"type": "string",
"nullable": true
},
"enrollmentSucceeded": {
"type": "boolean"
},
"convertedToACH": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.Paycards.TryEnrollPaycard.Result": {
"type": "object",
"properties": {
"enrollPaycardResult": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Paycards.EnrollPaycard.Result"
},
"exceptionOccurred": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.Paycards.UpdatePaycardStatusCommand.Result": {
"type": "object",
"properties": {
"statusChanged": {
"type": "boolean"
},
"paycardStatus": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.Paycards.ValidatePaycardAddressCommand.Result": {
"type": "object",
"properties": {
"street1": {
"type": "string",
"nullable": true
},
"street2": {
"type": "string",
"nullable": true
},
"municipality": {
"type": "string",
"nullable": true
},
"region": {
"type": "string",
"nullable": true
},
"postalCode": {
"type": "string",
"nullable": true
},
"countryCode": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.Paycards.ValidatePaycardCommand.Result": {
"type": "object",
"properties": {
"canBeIssued": {
"type": "boolean"
},
"canBeFunded": {
"type": "boolean"
},
"adpValidationResult": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.Adp.Service.Commands.ADPValidatePaycardAccountCommand.Result"
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.Paychecks.PaycheckAccrualsListQuery.Result": {
"type": "object",
"properties": {
"employeeAccrualItemId": {
"type": "string",
"format": "uuid"
},
"employeeAccrualId": {
"type": "string",
"format": "uuid"
},
"accrualId": {
"type": "string",
"format": "uuid"
},
"accrual": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"employeeAccrualTierId": {
"type": "string",
"format": "uuid"
},
"employeeAccrualTier": {
"type": "string",
"nullable": true
},
"accrualItemTypeId": {
"type": "string",
"format": "uuid"
},
"accrualItemType": {
"type": "string",
"nullable": true
},
"amount": {
"type": "number",
"format": "double"
},
"balance": {
"type": "number",
"format": "double"
},
"eligibleBalance": {
"type": "number",
"format": "double"
},
"eligibleAccrued": {
"type": "number",
"format": "double"
},
"availableBalance": {
"type": "number",
"format": "double"
},
"isAccrue": {
"type": "boolean"
},
"isDeplete": {
"type": "boolean"
},
"isManualAdjustment": {
"type": "boolean"
},
"notes": {
"type": "string",
"nullable": true
},
"customerId": {
"type": "integer",
"format": "int64"
},
"customerName": {
"type": "string",
"nullable": true
},
"weekendDate": {
"type": "string",
"format": "date-time"
},
"dateCreated": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.Paychecks.PaycheckAdjustmentsListQuery.Result": {
"type": "object",
"properties": {
"checkAdjustmentId": {
"type": "integer",
"format": "int64"
},
"checkDate": {
"type": "string",
"format": "date-time"
},
"adjustmentId": {
"type": "integer",
"format": "int32"
},
"adjustmentName": {
"type": "string",
"nullable": true
},
"adjustmentDescription": {
"type": "string",
"nullable": true
},
"adjustmentAmountWithheld": {
"type": "number",
"format": "double"
},
"adjustmentAmountWithheldYtd": {
"type": "number",
"format": "double"
},
"isEmployerPaidBenefit": {
"type": "boolean"
},
"checkId": {
"type": "integer",
"format": "int64"
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.Paychecks.PaycheckAllowancesListQuery.Result": {
"type": "object",
"properties": {
"checkTaxId": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string",
"nullable": true
},
"allowances": {
"type": "number",
"format": "double"
},
"dependentAllowance": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.Paychecks.PaycheckDetailsQuery.Result": {
"type": "object",
"properties": {
"paycheckId": {
"type": "integer",
"format": "int64"
},
"checkNumber": {
"type": "integer",
"format": "int32",
"nullable": true
},
"payrollRunId": {
"type": "integer",
"format": "int32"
},
"checkDate": {
"type": "string",
"format": "date-time"
},
"processDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"printDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"weekendBill": {
"type": "string",
"format": "date-time"
},
"clearedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"checkStatus": {
"type": "string",
"nullable": true
},
"paidToTheOrderOf": {
"type": "string",
"nullable": true
},
"addressBox": {
"type": "string",
"nullable": true
},
"payeeType": {
"type": "string",
"nullable": true
},
"isElectronicPay": {
"type": "boolean"
},
"grossPay": {
"type": "number",
"format": "double"
},
"totalAdjustmentAmountWithheld": {
"type": "number",
"format": "double"
},
"netPay": {
"type": "number",
"format": "double"
},
"totalEmployeeTaxAmountWithheld": {
"type": "number",
"format": "double"
},
"regularHours": {
"type": "number",
"format": "double"
},
"overtimeHours": {
"type": "number",
"format": "double"
},
"doubletimeHours": {
"type": "number",
"format": "double"
},
"totalHours": {
"type": "number",
"format": "double"
},
"employerId": {
"type": "integer",
"format": "int32"
},
"employer": {
"type": "string",
"nullable": true
},
"federalExemptions": {
"type": "integer",
"format": "int32"
},
"stateExemptions": {
"type": "integer",
"format": "int32"
},
"checkDelivery": {
"type": "string",
"nullable": true
},
"taxState": {
"type": "string",
"nullable": true
},
"bankID": {
"type": "integer",
"format": "int32"
},
"bankName": {
"type": "string",
"nullable": true
},
"bankAddress": {
"type": "string",
"nullable": true
},
"einc": {
"type": "integer",
"format": "int32"
},
"federalMaritalStatus": {
"type": "string",
"nullable": true
},
"misc1": {
"type": "number",
"format": "double",
"nullable": true
},
"misc2": {
"type": "number",
"format": "double",
"nullable": true
},
"misc3": {
"type": "number",
"format": "double",
"nullable": true
},
"reserved": {
"type": "string",
"nullable": true
},
"replacedByPaycheckId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"replacedByCheckNumber": {
"type": "string",
"nullable": true
},
"replacesPaycheckId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"replacesCheckNumber": {
"type": "string",
"nullable": true
},
"allowances": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Paychecks.PaycheckAllowancesListQuery.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
},
"adjustments": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Paychecks.PaycheckAdjustmentsListQuery.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
},
"taxes": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Paychecks.PaycheckTaxesListQuery.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
},
"transactions": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Paychecks.PaycheckTransactionsListQuery.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
},
"accruals": {
"$ref": "#/components/schemas/TwApi.Common.Infrastructure.PagedList`1[[TwApi.Services.Payroll.Service.Commands.Paychecks.PaycheckAccrualsListQuery.Result, Payroll.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.Paychecks.PaycheckTaxesListQuery.Result": {
"type": "object",
"properties": {
"checkTaxId": {
"type": "integer",
"format": "int64"
},
"taxableAmount": {
"type": "number",
"format": "double"
},
"taxAmountWithheld": {
"type": "number",
"format": "double"
},
"taxJurisdictionGrossAmount": {
"type": "number",
"format": "double"
},
"taxableAmountYtd": {
"type": "number",
"format": "double"
},
"taxAmountWithheldYtd": {
"type": "number",
"format": "double"
},
"taxJurisdictionGrossAmountYtd": {
"type": "number",
"format": "double"
},
"taxJurisdictionId": {
"type": "integer",
"format": "int32"
},
"taxJurisdiction": {
"type": "string",
"nullable": true
},
"allowances": {
"type": "integer",
"format": "int32"
},
"additionalAllowances": {
"type": "integer",
"format": "int32"
},
"dependentAllowance": {
"type": "number",
"format": "double",
"nullable": true
},
"nextAmountTax": {
"type": "number",
"format": "double"
},
"nextAmountTaxable": {
"type": "number",
"format": "double"
},
"nextJurisGross": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.Paychecks.PaycheckTransactionsListQuery.Result": {
"type": "object",
"properties": {
"transactionId": {
"type": "integer",
"format": "int64"
},
"assignmentId": {
"type": "integer",
"format": "int64"
},
"jobOrderId": {
"type": "integer",
"format": "int64"
},
"jobTitle": {
"type": "string",
"nullable": true
},
"customerId": {
"type": "integer",
"format": "int64"
},
"customerName": {
"type": "string",
"nullable": true
},
"departmentName": {
"type": "string",
"nullable": true
},
"regularHours": {
"type": "number",
"format": "double"
},
"regularPayRate": {
"type": "number",
"format": "double"
},
"overtimeHours": {
"type": "number",
"format": "double"
},
"overtimePayRate": {
"type": "number",
"format": "double"
},
"doubletimeHours": {
"type": "number",
"format": "double"
},
"doubletimePayRate": {
"type": "number",
"format": "double"
},
"units": {
"type": "number",
"format": "double"
},
"unitPayRate": {
"type": "number",
"format": "double"
},
"salary": {
"type": "number",
"format": "double"
},
"weekendDate": {
"type": "string",
"format": "date-time"
},
"weekendBill": {
"type": "string",
"format": "date-time"
},
"payCodeId": {
"type": "integer",
"format": "int32"
},
"payCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.Proofing.GetIncompleteTimecards.Result": {
"type": "object",
"properties": {
"timecardId": {
"type": "integer",
"format": "int32"
},
"employeeName": {
"type": "string",
"nullable": true
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"customerId": {
"type": "integer",
"format": "int64"
},
"customerName": {
"type": "string",
"nullable": true
},
"departmentName": {
"type": "string",
"nullable": true
},
"fullCustomerName": {
"type": "string",
"nullable": true
},
"skillCode": {
"type": "string",
"nullable": true
},
"jobTitle": {
"type": "string",
"nullable": true
},
"jobOrderId": {
"type": "integer",
"format": "int64"
},
"assignmentId": {
"type": "integer",
"format": "int64"
},
"branchName": {
"type": "string",
"nullable": true
},
"proofingSessionId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"weekendBill": {
"type": "string",
"format": "date-time"
},
"weekendDate": {
"type": "string",
"format": "date-time"
},
"originalWeekendBill": {
"type": "string",
"format": "date-time"
},
"timecardIsLinked": {
"type": "boolean"
},
"timecardIsProofed": {
"type": "boolean"
},
"timecardIsPaid": {
"type": "boolean"
},
"timecardIsInvoiced": {
"type": "boolean"
},
"isWebCenterTimecard": {
"type": "boolean"
},
"timecardIsPosted": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.Proofing.GetNonBillableTimecards.Result": {
"type": "object",
"properties": {
"timecardId": {
"type": "integer",
"format": "int32"
},
"isNotBillable": {
"type": "boolean"
},
"employeeName": {
"type": "string",
"nullable": true
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"customerId": {
"type": "integer",
"format": "int64"
},
"customerName": {
"type": "string",
"nullable": true
},
"jobOrderId": {
"type": "integer",
"format": "int64"
},
"jobTitle": {
"type": "string",
"nullable": true
},
"originalWeekendBill": {
"type": "string",
"format": "date-time"
},
"payRate": {
"type": "number",
"format": "double"
},
"payCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.Proofing.GetNonPayableTimecards.Result": {
"type": "object",
"properties": {
"timecardId": {
"type": "integer",
"format": "int32"
},
"timecardIsPaid": {
"type": "boolean"
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"employeeName": {
"type": "string",
"nullable": true
},
"jobTitle": {
"type": "string",
"nullable": true
},
"customerId": {
"type": "integer",
"format": "int64"
},
"customerName": {
"type": "string",
"nullable": true
},
"departmentName": {
"type": "string",
"nullable": true
},
"jobOrderId": {
"type": "integer",
"format": "int64"
},
"originalWeekendBill": {
"type": "string",
"format": "date-time"
},
"billRate": {
"type": "number",
"format": "double"
},
"payCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.Proofing.GetTimecardProofingErrors.Result": {
"type": "object",
"properties": {
"errorId": {
"type": "integer",
"format": "int32"
},
"proofingSessionId": {
"type": "integer",
"format": "int32"
},
"proofingError": {
"type": "string",
"nullable": true
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"employeeName": {
"type": "string",
"nullable": true
},
"timecardId": {
"type": "integer",
"format": "int32"
},
"customerId": {
"type": "integer",
"format": "int64"
},
"customerName": {
"type": "string",
"nullable": true
},
"weekendDate": {
"type": "string",
"format": "date-time"
},
"weekendBill": {
"type": "string",
"format": "date-time"
},
"payCode": {
"type": "string",
"nullable": true
},
"regularHours": {
"type": "number",
"format": "double"
},
"overTimeHours": {
"type": "number",
"format": "double"
},
"regularPayRate": {
"type": "number",
"format": "double"
},
"overTimePayRate": {
"type": "number",
"format": "double"
},
"estimatedGross": {
"type": "number",
"format": "double"
},
"regularBillRate": {
"type": "number",
"format": "double"
},
"overtimeBillRate": {
"type": "number",
"format": "double"
},
"doubleTimeBillRate": {
"type": "number",
"format": "double"
},
"doubleTimePayRate": {
"type": "number",
"format": "double"
},
"units": {
"type": "number",
"format": "double"
},
"unitBillRate": {
"type": "number",
"format": "double"
},
"unitPayRate": {
"type": "number",
"format": "double"
},
"assignmentId": {
"type": "integer",
"format": "int64"
},
"orderId": {
"type": "integer",
"format": "int64"
},
"timecardSourceId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"timecardSource": {
"type": "string",
"nullable": true
},
"severityId": {
"type": "integer",
"format": "int32"
},
"severity": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.Proofing.GetTimecardProofingSessions.Result": {
"type": "object",
"properties": {
"proofingSessionId": {
"type": "integer",
"format": "int32"
},
"proofingSessionName": {
"type": "string",
"nullable": true
},
"proofingSessionHierId": {
"type": "integer",
"format": "int32"
},
"proofingSessionHierName": {
"type": "string",
"nullable": true
},
"proofingSessionHierTypeName": {
"type": "string",
"nullable": true
},
"serviceRepId": {
"type": "integer",
"format": "int64"
},
"serviceRep": {
"type": "string",
"nullable": true
},
"numberOfTotalTimecards": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"proofingSessionWeekendBillDate": {
"type": "string",
"format": "date-time"
},
"proofingSessionDateEnded": {
"type": "string",
"format": "date-time",
"nullable": true
},
"proofingSessionProofEndDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"numberOfTimecardsAbleToBeProofed": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.Proofing.GetTimecardsByProofingSessionWithFilters.Result": {
"type": "object",
"properties": {
"timecardId": {
"type": "integer",
"format": "int32"
},
"customerName": {
"type": "string",
"nullable": true
},
"customerId": {
"type": "integer",
"format": "int64"
},
"departmentName": {
"type": "string",
"nullable": true
},
"employeeName": {
"type": "string",
"nullable": true
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"assignmentId": {
"type": "integer",
"format": "int64"
},
"jobOrderId": {
"type": "integer",
"format": "int64"
},
"payCode": {
"type": "string",
"nullable": true
},
"regularBillRate": {
"type": "number",
"format": "double"
},
"regularPayRate": {
"type": "number",
"format": "double"
},
"overTimeHours": {
"type": "number",
"format": "double"
},
"estimatedGross": {
"type": "number",
"format": "double"
},
"regularHours": {
"type": "number",
"format": "double"
},
"overtimeBillRate": {
"type": "number",
"format": "double"
},
"overTimePayRate": {
"type": "number",
"format": "double"
},
"doubleTimeHours": {
"type": "number",
"format": "double"
},
"doubleTimeBillRate": {
"type": "number",
"format": "double"
},
"doubleTimePayRate": {
"type": "number",
"format": "double"
},
"weekendBill": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.Proofing.TimecardsProofingMetadata.Result": {
"type": "object",
"properties": {
"currentWeekendBill": {
"type": "string",
"format": "date-time"
},
"numberOfOpenSessions": {
"type": "integer",
"format": "int32"
},
"numberOfUnpaidTimesheets": {
"type": "integer",
"format": "int32"
},
"numberOfUnusedTimesheets": {
"type": "integer",
"format": "int32"
},
"numberOfLegacyErrorTypesUnableToBeProcessed": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.TimeEntry.ApproveTimecardProofingSessionErrors.Result": {
"type": "object",
"properties": {
"numberOfErrorsApproved": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.TimeEntry.CreateTimecardAdjustment.Result": {
"type": "object",
"properties": {
"timecardAdjustmentId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.TimeEntry.CreateTimecardAdjustmentDocument.Result": {
"type": "object",
"properties": {
"timecardAdjustmentDocumentId": {
"type": "integer",
"format": "int32"
},
"documentId": {
"type": "integer",
"format": "int32"
},
"fileName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.TimeEntry.CreateTimecardBatch.Result": {
"type": "object",
"properties": {
"batchJobId": {
"type": "integer",
"format": "int64",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.TimeEntry.CreateTimecardFromAssignment.Result": {
"type": "object",
"properties": {
"createTimecardsRunId": {
"type": "integer",
"format": "int32"
},
"timecardId": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.TimeEntry.CreateTimecards.Result": {
"type": "object",
"properties": {
"numberOfTimecardsCreated": {
"type": "integer",
"format": "int32",
"nullable": true
},
"createTimecardsRunId": {
"type": "integer",
"format": "int32"
},
"isCreateTimecardsRunComplete": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.TimeEntry.CreateTimecardsFromWeek.Result": {
"type": "object",
"properties": {
"createTimecardsRunId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.TimeEntry.GetAdjustmentsForTimecards.Result": {
"type": "object",
"properties": {
"adjustmentId": {
"type": "integer",
"format": "int32"
},
"adjustment": {
"type": "string",
"nullable": true
},
"category": {
"type": "string",
"nullable": true
},
"canBePaidToEmployee": {
"type": "boolean"
},
"canBeBilledToCustomer": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.TimeEntry.GetCreateTimecardRunStatus.Result": {
"type": "object",
"properties": {
"numberOfTimecardsCreated": {
"type": "integer",
"format": "int32",
"nullable": true
},
"createTimecardsRunId": {
"type": "integer",
"format": "int32"
},
"isCreateTimecardsRunComplete": {
"type": "boolean"
},
"statusMessage": {
"type": "string",
"nullable": true
},
"hasError": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardAdjustments.Result": {
"type": "object",
"properties": {
"timecardAdjustmentId": {
"type": "integer",
"format": "int32"
},
"adjustmentId": {
"type": "integer",
"format": "int32"
},
"adjustment": {
"type": "string",
"nullable": true
},
"payAmount": {
"type": "number",
"format": "double"
},
"billAmount": {
"type": "number",
"format": "double"
},
"canBePaidToEmployee": {
"type": "boolean"
},
"canBeBilledToCustomer": {
"type": "boolean"
},
"units": {
"type": "number",
"format": "double"
},
"amountToPayPerUnit": {
"type": "number",
"format": "double"
},
"amountToBillPerUnit": {
"type": "number",
"format": "double"
},
"invoiceText": {
"type": "string",
"nullable": true
},
"fileName": {
"type": "string",
"nullable": true
},
"documentId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardAssignmentAdjustments.Result": {
"type": "object",
"properties": {
"adjustmentId": {
"type": "integer",
"format": "int32"
},
"adjustment": {
"type": "string",
"nullable": true
},
"canBePaidToEmployee": {
"type": "boolean"
},
"canBeBilledToCustomer": {
"type": "boolean"
},
"defaultAmountToPayPerUnit": {
"type": "number",
"format": "double"
},
"defaultAmountToBillPerUnit": {
"type": "number",
"format": "double"
},
"adjustmentOnDuplicateTimecardId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardDetails": {
"type": "object",
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardDetails.Result": {
"type": "object",
"properties": {
"timecardId": {
"type": "integer",
"format": "int32"
},
"eTag": {
"type": "integer",
"format": "int64"
},
"accountCode": {
"type": "string",
"nullable": true
},
"assignmentId": {
"type": "integer",
"format": "int64"
},
"billRate": {
"type": "number",
"format": "double"
},
"branchId": {
"type": "integer",
"format": "int32"
},
"branchName": {
"type": "string",
"nullable": true
},
"checkDeliveryCode": {
"type": "string",
"nullable": true
},
"companyId": {
"type": "integer",
"format": "int32"
},
"company": {
"type": "string",
"nullable": true
},
"correctsTransactionId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"costCenter": {
"type": "string",
"nullable": true
},
"customerExtra1": {
"type": "string",
"nullable": true
},
"customerExtra2": {
"type": "string",
"nullable": true
},
"customerExtra3": {
"type": "string",
"nullable": true
},
"customerId": {
"type": "integer",
"format": "int64"
},
"customerName": {
"type": "string",
"nullable": true
},
"dateWorked": {
"type": "string",
"format": "date-time",
"nullable": true
},
"day1TotalHours": {
"type": "number",
"format": "double"
},
"day2TotalHours": {
"type": "number",
"format": "double"
},
"day3TotalHours": {
"type": "number",
"format": "double"
},
"day4TotalHours": {
"type": "number",
"format": "double"
},
"day5TotalHours": {
"type": "number",
"format": "double"
},
"day6TotalHours": {
"type": "number",
"format": "double"
},
"day7TotalHours": {
"type": "number",
"format": "double"
},
"departmentName": {
"type": "string",
"nullable": true
},
"doubletimeBillRate": {
"type": "number",
"format": "double"
},
"doubletimeHours": {
"type": "number",
"format": "double"
},
"doubletimePayRate": {
"type": "number",
"format": "double"
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"employeeName": {
"type": "string",
"nullable": true
},
"employer": {
"type": "string",
"nullable": true
},
"employerId": {
"type": "integer",
"format": "int32"
},
"federalOvertimeHours": {
"type": "number",
"format": "double",
"nullable": true
},
"federalOvertimeHoursOverride": {
"type": "boolean"
},
"gross": {
"type": "number",
"format": "double"
},
"hasBeenPosted": {
"type": "boolean"
},
"hasBeenProofed": {
"type": "boolean"
},
"hasLinkedTimecardDocument": {
"type": "boolean",
"nullable": true
},
"invoiceDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"invoiceHoldCode": {
"type": "string",
"nullable": true
},
"invoiceRunID": {
"type": "integer",
"format": "int32",
"nullable": true
},
"invoiceText": {
"type": "string",
"nullable": true
},
"isInInvoicing": {
"type": "boolean"
},
"isInvoiceDeliveryReady": {
"type": "boolean"
},
"isInPayroll": {
"type": "boolean"
},
"isInvoiceComplete": {
"type": "boolean"
},
"isPayrollComplete": {
"type": "boolean"
},
"isReadOnlyWebCenterTimecard": {
"type": "boolean",
"nullable": true
},
"isSalaryApproved": {
"type": "boolean"
},
"isW2": {
"type": "boolean"
},
"jobOrderId": {
"type": "integer",
"format": "int64"
},
"jobTitle": {
"type": "string",
"nullable": true
},
"jobTitleId": {
"type": "integer",
"format": "int32"
},
"location": {
"type": "string",
"nullable": true
},
"numberOfDaysWorked": {
"type": "integer",
"format": "int32"
},
"oneTimeDoNotEPay": {
"type": "string",
"nullable": true
},
"oneTimeOverrideFederalWithholding": {
"type": "number",
"format": "double",
"nullable": true
},
"oneTimeOverridePayPeriods": {
"type": "integer",
"format": "int32",
"nullable": true
},
"oneTimeOverrideRegionWithholding": {
"type": "number",
"format": "double",
"nullable": true
},
"originalWeekendBill": {
"type": "string",
"format": "date-time"
},
"overtimeBillRate": {
"type": "number",
"format": "double"
},
"overtimeHours": {
"type": "number",
"format": "double"
},
"overtimePayRate": {
"type": "number",
"format": "double"
},
"paycheckId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"payCode": {
"type": "string",
"nullable": true
},
"payCodeId": {
"type": "integer",
"format": "int32"
},
"payHoldCode": {
"type": "string",
"nullable": true
},
"payPeriodEndDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"payPeriodStartDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"payRate": {
"type": "number",
"format": "double"
},
"payrollNote": {
"type": "string",
"nullable": true
},
"payrollRunID": {
"type": "integer",
"format": "int32",
"nullable": true
},
"postedTransactionId": {
"type": "integer",
"format": "int64"
},
"proofingSessionId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"proofingSessionServiceRep": {
"type": "string",
"nullable": true
},
"proofingSessionServiceRepId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"purchaseOrderId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"purchaseOrderNumber": {
"type": "string",
"nullable": true
},
"regularHours": {
"type": "number",
"format": "double"
},
"requireSeparateCheck": {
"type": "boolean"
},
"requisitionNumber": {
"type": "string",
"nullable": true
},
"reversedCheckId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"salaryBillRate": {
"type": "number",
"format": "double"
},
"salaryPayRate": {
"type": "number",
"format": "double"
},
"showZeroBillOnInvoice": {
"type": "boolean"
},
"subEntity": {
"type": "string",
"nullable": true
},
"timecardAdjustmentTotalAmountBilled": {
"type": "number",
"format": "double",
"nullable": true
},
"timecardAdjustmentTotalAmountBilledPay": {
"type": "number",
"format": "double",
"nullable": true
},
"timecardAdjustmentTotalAmountUnbilledPay": {
"type": "number",
"format": "double",
"nullable": true
},
"timecardSourceId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"timecardSource": {
"type": "string",
"nullable": true
},
"timecardExternalSource": {
"type": "string",
"nullable": true
},
"timecardStatusId": {
"type": "integer",
"format": "int32"
},
"timecardStatus": {
"type": "string",
"nullable": true
},
"totalBill": {
"type": "number",
"format": "double"
},
"totalHours": {
"type": "number",
"format": "double"
},
"unitBillRate": {
"type": "number",
"format": "double"
},
"unitPayRate": {
"type": "number",
"format": "double"
},
"units": {
"type": "number",
"format": "double"
},
"vendorInvoiceNumber": {
"type": "string",
"nullable": true
},
"webTimecardId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"webTimecardStatus": {
"type": "string",
"nullable": true
},
"webTimecardStatusId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"weekendDate": {
"type": "string",
"format": "date-time"
},
"worksiteId": {
"type": "integer",
"format": "int32"
},
"worksiteName": {
"type": "string",
"nullable": true
},
"hasAssignmentAdjustments": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardImportErrors.Result": {
"type": "object",
"properties": {
"batchJobItemId": {
"type": "integer",
"format": "int64"
},
"batchJobItemStatusId": {
"type": "integer",
"format": "int64"
},
"batchJobItemStatus": {
"type": "string",
"nullable": true
},
"itemIdentifier": {
"type": "string",
"nullable": true
},
"originId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"originTypeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"dateCreated": {
"type": "string",
"format": "date-time"
},
"dateLastUpdated": {
"type": "string",
"format": "date-time"
},
"dateStarted": {
"type": "string",
"format": "date-time",
"nullable": true
},
"dateCompleted": {
"type": "string",
"format": "date-time",
"nullable": true
},
"hasFailed": {
"type": "boolean"
},
"statusInformation": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecardImportStatus.Result": {
"type": "object",
"properties": {
"batchJobId": {
"type": "integer",
"format": "int64"
},
"batchJobStatus": {
"type": "string",
"nullable": true
},
"totalTimecardRecords": {
"type": "integer",
"format": "int32"
},
"completedTimecardRecords": {
"type": "integer",
"format": "int32"
},
"failedTimecardRecords": {
"type": "integer",
"format": "int32"
},
"createdByServiceRepId": {
"type": "integer",
"format": "int32"
},
"createdByServiceRep": {
"type": "string",
"nullable": true
},
"dateCreated": {
"type": "string",
"format": "date-time"
},
"dateLastUpdated": {
"type": "string",
"format": "date-time"
},
"dateCompleted": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.TimeEntry.GetTimecards.Result": {
"type": "object",
"properties": {
"timecardId": {
"type": "integer",
"format": "int32"
},
"eTag": {
"type": "integer",
"format": "int64"
},
"assignmentId": {
"type": "integer",
"format": "int64"
},
"billRate": {
"type": "number",
"format": "double"
},
"branchId": {
"type": "integer",
"format": "int32"
},
"branchName": {
"type": "string",
"nullable": true
},
"customerId": {
"type": "integer",
"format": "int64"
},
"customerName": {
"type": "string",
"nullable": true
},
"dateWorked": {
"type": "string",
"format": "date-time",
"nullable": true
},
"day1TotalHours": {
"type": "number",
"format": "double"
},
"day2TotalHours": {
"type": "number",
"format": "double"
},
"day3TotalHours": {
"type": "number",
"format": "double"
},
"day4TotalHours": {
"type": "number",
"format": "double"
},
"day5TotalHours": {
"type": "number",
"format": "double"
},
"day6TotalHours": {
"type": "number",
"format": "double"
},
"day7TotalHours": {
"type": "number",
"format": "double"
},
"departmentName": {
"type": "string",
"nullable": true
},
"doubletimeBillRate": {
"type": "number",
"format": "double"
},
"doubletimeHours": {
"type": "number",
"format": "double"
},
"doubletimePayRate": {
"type": "number",
"format": "double"
},
"employeeName": {
"type": "string",
"nullable": true
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"hasBeenPosted": {
"type": "boolean"
},
"hasBeenProofed": {
"type": "boolean"
},
"hasLinkedTimecardDocument": {
"type": "boolean",
"nullable": true
},
"invoiceHoldCode": {
"type": "string",
"nullable": true
},
"isInInvoicing": {
"type": "boolean"
},
"isInPayroll": {
"type": "boolean"
},
"isInvoiceComplete": {
"type": "boolean"
},
"isInvoiceDeliveryReady": {
"type": "boolean"
},
"isPayrollComplete": {
"type": "boolean"
},
"isReadOnlyWebCenterTimecard": {
"type": "boolean",
"nullable": true
},
"isSalaryApproved": {
"type": "boolean"
},
"jobOrderId": {
"type": "integer",
"format": "int64"
},
"jobTitle": {
"type": "string",
"nullable": true
},
"jobTitleId": {
"type": "integer",
"format": "int32"
},
"overtimeBillRate": {
"type": "number",
"format": "double"
},
"overtimeHours": {
"type": "number",
"format": "double"
},
"overtimePayRate": {
"type": "number",
"format": "double"
},
"payCode": {
"type": "string",
"nullable": true
},
"payCodeId": {
"type": "integer",
"format": "int32"
},
"payRate": {
"type": "number",
"format": "double"
},
"proofingSessionId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"regularHours": {
"type": "number",
"format": "double"
},
"salaryBillRate": {
"type": "number",
"format": "double"
},
"salaryPayRate": {
"type": "number",
"format": "double"
},
"timecardSourceId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"timecardSource": {
"type": "string",
"nullable": true
},
"timecardExternalSource": {
"type": "string",
"nullable": true
},
"unitBillRate": {
"type": "number",
"format": "double"
},
"unitPayRate": {
"type": "number",
"format": "double"
},
"units": {
"type": "number",
"format": "double"
},
"webTimecardId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"webTimecardStatus": {
"type": "string",
"nullable": true
},
"webTimecardStatusId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"weekendDate": {
"type": "string",
"format": "date-time"
},
"worksiteId": {
"type": "integer",
"format": "int32"
},
"worksiteName": {
"type": "string",
"nullable": true
},
"hasAssignmentAdjustments": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.TimeEntry.MoveTimecardsIntoSession.Result": {
"type": "object",
"properties": {
"numberOfTimecardsMoved": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.TimeEntry.MoveWebcenterTimecardsIntoProofingSession.Result": {
"type": "object",
"properties": {
"numberOfTimecardsCreated": {
"type": "integer",
"format": "int32"
},
"proofingSessionId": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.TimeEntry.SplitSessionByHierarchyComparison.Result": {
"type": "object",
"properties": {
"newSessionId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.TimeEntry.UpdateTimecardBatch.Result": {
"type": "object",
"properties": {
"batchJobId": {
"type": "integer",
"format": "int64",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.WebTimecards.CreateWebTimecardAdjustment.Result": {
"type": "object",
"properties": {
"timecardAdjustmentId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.WebTimecards.CreateWebTimecardAdjustmentDocument.Result": {
"type": "object",
"properties": {
"timecardAdjustmentDocumentId": {
"type": "integer",
"format": "int32"
},
"documentId": {
"type": "integer",
"format": "int32"
},
"fileName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.WebTimecards.OrchestrateCreateWebTimecard.Result": {
"type": "object",
"properties": {
"webTimecardId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardAdjustmentsList.Result": {
"type": "object",
"properties": {
"timecardAdjustmentId": {
"type": "integer",
"format": "int32"
},
"adjustmentId": {
"type": "integer",
"format": "int32"
},
"adjustment": {
"type": "string",
"nullable": true
},
"payAmount": {
"type": "number",
"format": "double"
},
"units": {
"type": "number",
"format": "double"
},
"amountToPayPerUnit": {
"type": "number",
"format": "double"
},
"timecardAdjustmentDocumentId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"documentId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"fileName": {
"type": "string",
"nullable": true
},
"fileType": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardAssignmentMetadata.Result": {
"type": "object",
"properties": {
"weekendDay": {
"type": "string",
"nullable": true
},
"payPeriods": {
"type": "integer",
"format": "int32"
},
"periodStartDate": {
"type": "string",
"format": "date",
"nullable": true
},
"periodEndDate": {
"type": "string",
"format": "date",
"nullable": true
},
"weekendDate": {
"type": "string",
"format": "date",
"nullable": true
},
"lengthInDays": {
"type": "integer",
"format": "int32"
},
"defaultPayCodeId": {
"type": "integer",
"format": "int32"
},
"defaultPayCode": {
"type": "string",
"nullable": true
},
"defaultPayCodeDescription": {
"type": "string",
"nullable": true
},
"costCenters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Datalists.WebTimecardCostCentersForAssignment.Result"
},
"nullable": true
},
"payCodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Datalists.WebTimecardPaycodesForAssignment.Result"
},
"nullable": true
},
"suggestedCostCenters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.Datalists.WebTimecardSuggestedCostCenters.Result"
},
"nullable": true
},
"canCreateWebTimecard": {
"type": "boolean",
"nullable": true
},
"cannotCreateWebTimecardReason": {
"type": "string",
"nullable": true
},
"canEmployeeEditDueToConfiguration": {
"type": "boolean"
},
"canCreateDuplicateTimecards": {
"type": "boolean"
},
"assignmentCostCenterLabel": {
"type": "string",
"nullable": true
},
"timecardCostCenterLabel": {
"type": "string",
"nullable": true
},
"notesLabel": {
"type": "string",
"nullable": true
},
"buzzTimecardLegalAgreement": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardDetails.Result": {
"type": "object",
"properties": {
"webTimecardId": {
"type": "string",
"format": "uuid"
},
"assignmentId": {
"type": "integer",
"format": "int64"
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"webTimecardStatus": {
"type": "string",
"nullable": true
},
"webTimecardStatusId": {
"type": "integer",
"format": "int32"
},
"isReadOnlyWebCenterTimecard": {
"type": "boolean"
},
"canEmployeeEditDueToConfiguration": {
"type": "boolean"
},
"canCancelTimecardSubmission": {
"type": "boolean"
},
"webTimecardTemplateTypeId": {
"type": "string",
"format": "uuid"
},
"webTimecardTemplateType": {
"type": "string",
"nullable": true
},
"webTimecardTemplateId": {
"type": "string",
"format": "uuid"
},
"customerId": {
"type": "integer",
"format": "int64"
},
"customerName": {
"type": "string",
"nullable": true
},
"departmentName": {
"type": "string",
"nullable": true
},
"worksiteId": {
"type": "integer",
"format": "int32"
},
"worksiteName": {
"type": "string",
"nullable": true
},
"jobTitleId": {
"type": "integer",
"format": "int32"
},
"jobTitle": {
"type": "string",
"nullable": true
},
"periodStartDate": {
"type": "string",
"format": "date"
},
"periodEndDate": {
"type": "string",
"format": "date"
},
"weekendDate": {
"type": "string",
"format": "date"
},
"numberOfAdjustments": {
"type": "integer",
"format": "int32"
},
"totalAdjustmentPayAmount": {
"type": "number",
"format": "double"
},
"costCenter": {
"type": "string",
"nullable": true
},
"payCodeId": {
"type": "integer",
"format": "int32"
},
"payCode": {
"type": "string",
"nullable": true
},
"payCodeDescription": {
"type": "string",
"nullable": true
},
"payRate": {
"type": "number",
"format": "double"
},
"overtimePayRate": {
"type": "number",
"format": "double"
},
"doubletimePayRate": {
"type": "number",
"format": "double"
},
"comments": {
"type": "string",
"nullable": true
},
"customField1": {
"type": "string",
"nullable": true
},
"customField2": {
"type": "string",
"nullable": true
},
"rejectedReason": {
"type": "string",
"nullable": true
},
"certified": {
"type": "boolean"
},
"weeklyTime": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Models.WeeklyTime"
},
"dailyTimes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Models.IDailyTime"
},
"nullable": true
},
"adjustments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardDetails.Result.AdjustmentDetails"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardDetails.Result.AdjustmentDetails": {
"type": "object",
"properties": {
"timecardAdjustmentId": {
"type": "integer",
"format": "int64"
},
"adjustmentId": {
"type": "integer",
"format": "int32"
},
"adjustment": {
"type": "string",
"nullable": true
},
"payAmount": {
"type": "number",
"format": "double"
},
"units": {
"type": "number",
"format": "double"
},
"amountToPayPerUnit": {
"type": "number",
"format": "double"
},
"timecardAdjustmentDocumentId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"documentId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"fileName": {
"type": "string",
"nullable": true
},
"fileType": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardDocumentsList.Result": {
"type": "object",
"properties": {
"webTimecardId": {
"type": "string",
"format": "uuid"
},
"webTimecardTemplateId": {
"type": "string",
"format": "uuid"
},
"assignmentId": {
"type": "integer",
"format": "int64"
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"documentId": {
"type": "integer",
"format": "int64"
},
"documentDate": {
"type": "string",
"nullable": true
},
"documentDateUTC": {
"type": "string",
"nullable": true
},
"documentDescription": {
"type": "string",
"nullable": true
},
"documentName": {
"type": "string",
"nullable": true
},
"documentOriginalName": {
"type": "string",
"nullable": true
},
"fileType": {
"type": "string",
"nullable": true
},
"showDocumentUpload": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardListGroupedByAssignmentAndWeekend.Result": {
"type": "object",
"properties": {
"assignmentId": {
"type": "integer",
"format": "int64"
},
"weekendDate": {
"type": "string",
"format": "date"
},
"periodStartDate": {
"type": "string",
"format": "date"
},
"periodEndDate": {
"type": "string",
"format": "date"
},
"jobTitle": {
"type": "string",
"nullable": true
},
"customerName": {
"type": "string",
"nullable": true
},
"departmentName": {
"type": "string",
"nullable": true
},
"timecards": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardListGroupedByAssignmentAndWeekend.Result.WebTimecardSummary"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardListGroupedByAssignmentAndWeekend.Result.WebTimecardSummary": {
"type": "object",
"properties": {
"webTimecardId": {
"type": "string",
"format": "uuid"
},
"assignmentId": {
"type": "integer",
"format": "int64"
},
"webTimecardStatus": {
"type": "string",
"nullable": true
},
"webTimecardStatusId": {
"type": "integer",
"format": "int32"
},
"isReadOnlyWebCenterTimecard": {
"type": "boolean"
},
"canCancelTimecardSubmission": {
"type": "boolean"
},
"webTimecardTemplateTypeId": {
"type": "string",
"format": "uuid"
},
"webTimecardTemplateType": {
"type": "string",
"nullable": true
},
"webTimecardTemplateId": {
"type": "string",
"format": "uuid"
},
"jobTitle": {
"type": "string",
"nullable": true
},
"numberOfAdjustments": {
"type": "integer",
"format": "int32"
},
"totalAdjustmentPayAmount": {
"type": "number",
"format": "double"
},
"costCenter": {
"type": "string",
"nullable": true
},
"payCodeId": {
"type": "integer",
"format": "int32"
},
"payCode": {
"type": "string",
"nullable": true
},
"payCodeDescription": {
"type": "string",
"nullable": true
},
"comments": {
"type": "string",
"nullable": true
},
"customField1": {
"type": "string",
"nullable": true
},
"customField2": {
"type": "string",
"nullable": true
},
"rejectedReason": {
"type": "string",
"nullable": true
},
"weeklyTime": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Models.WeeklyTime"
},
"dailyTimes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Models.IDailyTime"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardTemplateDetails.Result": {
"type": "object",
"properties": {
"arePayCodesReadOnly": {
"type": "boolean"
},
"customBreak1Label": {
"type": "string",
"nullable": true
},
"customBreak2Label": {
"type": "string",
"nullable": true
},
"customLunch1InMinutesLabel": {
"type": "string",
"nullable": true
},
"customLunch2InMinutesLabel": {
"type": "string",
"nullable": true
},
"customField1Label": {
"type": "string",
"nullable": true
},
"customField2Label": {
"type": "string",
"nullable": true
},
"isCommentRequired": {
"type": "boolean"
},
"isCostCenterFreeText": {
"type": "boolean"
},
"isCustomField1Required": {
"type": "boolean"
},
"isCustomField2Required": {
"type": "boolean"
},
"isDTPayRateReadOnly": {
"type": "boolean"
},
"isOTPayRateReadOnly": {
"type": "boolean"
},
"isPayRateReadOnly": {
"type": "boolean"
},
"isSalaryReadOnly": {
"type": "boolean"
},
"showAdjustments": {
"type": "boolean"
},
"showBreak1": {
"type": "boolean"
},
"showBreak2": {
"type": "boolean"
},
"showCertified": {
"type": "boolean"
},
"showComment": {
"type": "boolean"
},
"showCostCenters": {
"type": "boolean"
},
"showCustomField1": {
"type": "boolean"
},
"showCustomField2": {
"type": "boolean"
},
"showDHours": {
"type": "boolean"
},
"showDocumentUpload": {
"type": "boolean"
},
"showDTPayRate": {
"type": "boolean"
},
"showHourlyTotal": {
"type": "boolean"
},
"showLunch1": {
"type": "boolean"
},
"showLunch1InMinutes": {
"type": "boolean"
},
"showLunch2": {
"type": "boolean"
},
"showLunch2InMinutes": {
"type": "boolean"
},
"showOHours": {
"type": "boolean"
},
"showOTPayRate": {
"type": "boolean"
},
"showPayCodes": {
"type": "boolean"
},
"showPayRate": {
"type": "boolean"
},
"showReimbursements": {
"type": "boolean"
},
"showRHours": {
"type": "boolean"
},
"showSalary": {
"type": "boolean"
},
"showShift2": {
"type": "boolean"
},
"showUnitBillRate": {
"type": "boolean"
},
"showUnitPayRate": {
"type": "boolean"
},
"webTimecardTemplate": {
"type": "string",
"nullable": true
},
"webTimecardTemplateId": {
"type": "string",
"format": "uuid"
},
"webTimecardTemplateType": {
"type": "string",
"nullable": true
},
"webTimecardTemplateTypeId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Commands.WebTimecards.WebTimecardsList.WebTimecardSummaryResponse": {
"type": "object",
"properties": {
"webTimecardId": {
"type": "string",
"format": "uuid"
},
"assignmentId": {
"type": "integer",
"format": "int64"
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"webTimecardStatus": {
"type": "string",
"nullable": true
},
"webTimecardStatusId": {
"type": "integer",
"format": "int32"
},
"isReadOnlyWebCenterTimecard": {
"type": "boolean"
},
"canCancelTimecardSubmission": {
"type": "boolean"
},
"webTimecardTemplateTypeId": {
"type": "string",
"format": "uuid"
},
"webTimecardTemplateType": {
"type": "string",
"nullable": true
},
"webTimecardTemplateId": {
"type": "string",
"format": "uuid"
},
"customerId": {
"type": "integer",
"format": "int64"
},
"customerName": {
"type": "string",
"nullable": true
},
"departmentName": {
"type": "string",
"nullable": true
},
"worksiteId": {
"type": "integer",
"format": "int32"
},
"worksiteName": {
"type": "string",
"nullable": true
},
"jobTitleId": {
"type": "integer",
"format": "int32"
},
"jobTitle": {
"type": "string",
"nullable": true
},
"periodStartDate": {
"type": "string",
"format": "date"
},
"periodEndDate": {
"type": "string",
"format": "date"
},
"weekendDate": {
"type": "string",
"format": "date"
},
"numberOfAdjustments": {
"type": "integer",
"format": "int32"
},
"totalAdjustmentPayAmount": {
"type": "number",
"format": "double"
},
"costCenter": {
"type": "string",
"nullable": true
},
"payCodeId": {
"type": "integer",
"format": "int32"
},
"payCode": {
"type": "string",
"nullable": true
},
"payCodeDescription": {
"type": "string",
"nullable": true
},
"comments": {
"type": "string",
"nullable": true
},
"customField1": {
"type": "string",
"nullable": true
},
"customField2": {
"type": "string",
"nullable": true
},
"rejectedReason": {
"type": "string",
"nullable": true
},
"weeklyTime": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Models.WeeklyTime"
},
"dailyTimes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Payroll.Service.Models.IDailyTime"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Enums.ProofingSessionsStatusFilter": {
"enum": [
1,
2,
3
],
"type": "integer",
"format": "int32"
},
"TwApi.Services.Payroll.Service.Enums.TimecardGenerationType": {
"enum": [
0,
3,
4
],
"type": "integer",
"format": "int32"
},
"TwApi.Services.Payroll.Service.Models.EmployeeEnrollmentValidationError": {
"type": "object",
"properties": {
"propertyName": {
"type": "string",
"nullable": true
},
"resourceLocation": {
"type": "string",
"nullable": true
},
"message": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Models.IDailyTime": {
"type": "object",
"properties": {
"day": {
"type": "integer",
"format": "int32"
},
"date": {
"type": "string",
"format": "date-time"
},
"totalHours": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"TwApi.Services.Payroll.Service.Models.WeeklyTime": {
"type": "object",
"properties": {
"regularHours": {
"maximum": 2147483647,
"minimum": 0,
"type": "number",
"format": "double"
},
"overtimeHours": {
"maximum": 2147483647,
"minimum": 0,
"type": "number",
"format": "double"
},
"doubletimeHours": {
"maximum": 2147483647,
"minimum": 0,
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"TwApi.Services.Prospects.API.Models.ConvertProspectToCustomerRequest": {
"required": [
"copyDocuments",
"copyMessages"
],
"type": "object",
"properties": {
"prospectContactIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "An array of ProspectContactIds to get converted over to contacts.",
"nullable": true
},
"branchId": {
"type": "integer",
"description": "An optional Branch to create the Customer at. If no Branch is specified, it will use the user's current Branch.\r\nA list of Branches can be found from the Branches Datalist.",
"format": "int32",
"nullable": true
},
"copyDocuments": {
"type": "boolean",
"description": "If set to true, documents linked to the Prospect will be copied over to the new customer. Copies will still remain\r\nattached to the prospect. Defaults to true."
},
"copyMessages": {
"type": "boolean",
"description": "If set to true, Messages linked to the Prospect will be linked to the new Customer. Defaults to true."
},
"bypassAddressValidationService": {
"type": "boolean",
"description": "If true, address validation will be bypassed and the address will save as long as all other validation passes."
}
},
"additionalProperties": false,
"description": "A request to convert a prospect into a customer with options for what gets copied."
},
"TwApi.Services.Prospects.API.Models.CreateProspectContactRequest": {
"type": "object",
"properties": {
"firstName": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "The Prospect Contact's First Name",
"nullable": true
},
"lastName": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "The Prospect Contact's Last Name",
"nullable": true
},
"title": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "The Prospect Contact's Title",
"nullable": true
},
"emailAddress": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "The Prospect Contact's Email Address",
"nullable": true
},
"phoneNumber": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "The Prospect Contact's Phone Number",
"nullable": true
},
"phoneNumberCountryCallingCode": {
"type": "integer",
"description": "The Country Calling Code of the Prospect Contact's Phone Number",
"format": "int32",
"nullable": true
},
"makePrimaryProspectContact": {
"type": "boolean",
"description": "If set to true, the new Prospect Contact will be made the Primary Prospect Contact"
}
},
"additionalProperties": false,
"description": "A request containing the information needed to create a Prospect Contact"
},
"TwApi.Services.Prospects.API.Models.CreateProspectRequest": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "The name of the Prospect."
},
"department": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "The department name of the Prospect",
"nullable": true
},
"emailAddress": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "The main email address for the Prospect.",
"nullable": true
},
"phoneNumber": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "The main phone number for the Prospect",
"nullable": true
},
"phoneNumberCountryCallingCode": {
"type": "integer",
"description": "The Country Calling Code of the Prospect's Phone Number",
"format": "int32",
"nullable": true
},
"primaryProspectContactFirstName": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "The first name of the primary person to contact at the Prospect.",
"nullable": true
},
"primaryProspectContactLastName": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "The last name of the primary person to contact at the Prospect.",
"nullable": true
},
"primaryProspectContactTitle": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "The title of the primary person to contact at the Prospect.",
"nullable": true
},
"street1": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "The first part of the street address of the Prospect.",
"nullable": true
},
"street2": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "The second part of the street address of the Prospect.",
"nullable": true
},
"municipality": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "The municipality of the Prospect.",
"nullable": true
},
"region": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "The region of the Prospect. A list of regions can be found at the Regions Datalist.",
"nullable": true
},
"postalCode": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "The postal of the Prospect.",
"nullable": true
},
"countryCode": {
"type": "integer",
"description": "The country code of the Prospect. A list of country codes can be found at the Countries Datalist",
"format": "int32",
"nullable": true
},
"source": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "The source of the Prospect.",
"nullable": true
},
"teamId": {
"type": "integer",
"description": "The Id of team assigned to the Prospect. A list of teams can be found at the Service Rep Teams Datalist endpoint.",
"format": "int32",
"nullable": true
},
"notes": {
"type": "string",
"description": "Notes about the Prospect",
"nullable": true
},
"bypassAddressValidationService": {
"type": "boolean",
"description": "If true, address validation will be bypassed and the address will save as long as all other validation passes.\r\nDefaults to true."
}
},
"additionalProperties": false,
"description": "A request containing information that can be provided when creating a contact."
},
"TwApi.Services.Prospects.API.Models.UpdateProspectAddressRequest": {
"required": [
"countryCode",
"municipality",
"postalCode",
"region",
"street1"
],
"type": "object",
"properties": {
"street1": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "The first part of the street address of the Prospect."
},
"street2": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "The second part of the street address of the Prospect.",
"nullable": true
},
"municipality": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "The municipality of the Prospect."
},
"region": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "The region of the Prospect. A list of regions can be found at the Regions Datalist."
},
"postalCode": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "The postal of the Prospect."
},
"countryCode": {
"type": "integer",
"description": "The country code of the Prospect. A list of country codes can be found at the Countries Datalist",
"format": "int32"
},
"bypassAddressValidationService": {
"type": "boolean",
"description": "If true, address validation will be bypassed and the address will save as long as all other validation passes.\r\nDefaults to true."
}
},
"additionalProperties": false,
"description": "A request containing updated address information about the Prospect."
},
"TwApi.Services.Prospects.Service.Commands.CreateProspect.Result": {
"type": "object",
"properties": {
"prospectId": {
"type": "integer",
"format": "int64"
}
},
"additionalProperties": false
},
"TwApi.Services.Prospects.Service.Commands.CreateProspectContact.Result": {
"type": "object",
"properties": {
"prospectContactId": {
"type": "integer",
"format": "int64"
}
},
"additionalProperties": false
},
"TwApi.Services.Prospects.Service.Commands.ProspectContactList.Result": {
"type": "object",
"properties": {
"prospectContactId": {
"type": "integer",
"format": "int64"
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"emailAddress": {
"type": "string",
"nullable": true
},
"phoneNumber": {
"type": "string",
"nullable": true
},
"phoneNumberCountryCallingCode": {
"type": "integer",
"format": "int32",
"nullable": true
},
"isPrimaryContact": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.RateSheets.API.Models.CreateRateSheetRequest": {
"type": "object",
"properties": {
"employeeId": {
"type": "integer",
"description": "The Id of the employee associated with this rate sheet.",
"format": "int64",
"nullable": true
},
"customerId": {
"type": "integer",
"description": "The Id of the customer associated with this rate sheet.",
"format": "int64",
"nullable": true
},
"worksiteId": {
"type": "integer",
"description": "The Id of the worksite associated with this rate sheet. Valid worksites can be found in the Customer Worksites list.",
"format": "int32",
"nullable": true
},
"jobTitleId": {
"type": "integer",
"description": "The Id of the job title associated with this rate sheet. Valid job titles can be found in the Job Title Datalist.",
"format": "int32",
"nullable": true
},
"branchId": {
"type": "integer",
"description": "The Id of the branch associated with this rate sheet. Valid branches can be found in the Branches datalist.",
"format": "int32",
"nullable": true
},
"shiftId": {
"type": "string",
"description": "The Id of the shift associated with this rate sheet. Valid shifts can be found in the Shifts datalist, or the Customer Default Shifts list.",
"format": "uuid",
"nullable": true
},
"workerCompCodeId": {
"type": "integer",
"description": "The Id of the worker comp code associated with this rate sheet. Valid worker comp codes can be found in the Worker Comp Codes Datalist, or the Customer Default Worker Comp Codes list.",
"format": "int32",
"nullable": true
},
"applyRateSheetToCustomerDepartments": {
"type": "boolean",
"description": "Indicates whether this rate sheet should apply to the departments of the customer indicated by the CustomerId.",
"nullable": true
},
"multiplierCodeId": {
"type": "integer",
"description": "The id of the multiplier code associated with this rate sheet. Valid multiplier codes can be found in the Multiplier Codes Datalist, or the Customer Default Multiplier Codes list.",
"format": "int32",
"nullable": true
},
"payRate": {
"type": "number",
"description": "The pay rate which can be applied to this rate sheet's job orders and assignments",
"format": "double",
"nullable": true
},
"overtimePayRate": {
"type": "number",
"description": "The overtime pay rate which can be applied to this rate sheet's job orders and assignments",
"format": "double",
"nullable": true
},
"doubletimePayRate": {
"type": "number",
"description": "The doubletime pay rate which can be applied to this rate sheet's job orders and assignments",
"format": "double",
"nullable": true
},
"unitPayRate": {
"type": "number",
"description": "The unit pay rate which can be applied to this rate sheet's job orders and assignments",
"format": "double",
"nullable": true
},
"subsPayRate": {
"type": "number",
"description": "The subs pay rate which can be applied to this rate sheet's job orders and assignments",
"format": "double",
"nullable": true
},
"billRate": {
"type": "number",
"description": "The bill rate which can be applied to this rate sheet's job orders and assignments",
"format": "double",
"nullable": true
},
"overtimeBillRate": {
"type": "number",
"description": "The overtime bill rate which can be applied to this rate sheet's job orders and assignments",
"format": "double",
"nullable": true
},
"doubletimeBillRate": {
"type": "number",
"description": "The doubletime bill rate which can be applied to this rate sheet's job orders and assignments",
"format": "double",
"nullable": true
},
"unitBillRate": {
"type": "number",
"description": "The unit bill rate which can be applied to this rate sheet's job orders and assignments",
"format": "double",
"nullable": true
},
"overtimeFactor": {
"type": "number",
"description": "The overtime factor which can be applied to this rate sheet's job orders and assignments",
"format": "double",
"nullable": true
},
"doubletimeFactor": {
"type": "number",
"description": "The doubletime factor which can be applied to this rate sheet's job orders and assignments",
"format": "double",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to create a Rate Sheet."
},
"TwApi.Services.RateSheets.API.Models.UpdateRateSheetRequest": {
"type": "object",
"properties": {
"isActive": {
"type": "boolean",
"description": "Indicates whether this rate sheet is active",
"nullable": true
},
"employeeId": {
"type": "integer",
"description": "The Id of the employee associated with this rate sheet.",
"format": "int64",
"nullable": true
},
"customerId": {
"type": "integer",
"description": "The Id of the customer associated with this rate sheet.",
"format": "int64",
"nullable": true
},
"worksiteId": {
"type": "integer",
"description": "The Id of the worksite associated with this rate sheet. Valid worksites can be found in the Customer Worksites list.",
"format": "int32",
"nullable": true
},
"jobTitleId": {
"type": "integer",
"description": "The Id of the job title associated with this rate sheet. Valid job titles can be found in the Job Title Datalist.",
"format": "int32",
"nullable": true
},
"branchId": {
"type": "integer",
"description": "The Id of the branch associated with this rate sheet. Valid branches can be found in the Branches datalist.",
"format": "int32",
"nullable": true
},
"shiftId": {
"type": "string",
"description": "The Id of the shift associated with this rate sheet. Valid shifts can be found in the Shifts datalist, or the Customer Default Shifts list.",
"format": "uuid",
"nullable": true
},
"workerCompCodeId": {
"type": "integer",
"description": "The Id of the worker comp code associated with this rate sheet. Valid worker comp codes can be found in the Worker Comp Codes Datalist, or the Customer Default Worker Comp Codes list.",
"format": "int32",
"nullable": true
},
"applyRateSheetToCustomerDepartments": {
"type": "boolean",
"description": "Indicates whether this rate sheet should apply to the departments of the customer indicated by the CustomerId.",
"nullable": true
},
"multiplierCodeId": {
"type": "integer",
"description": "The id of the multiplier code associated with this rate sheet. Valid multiplier codes can be found in the Multiplier Codes Datalist, or the Customer Default Multiplier Codes list.",
"format": "int32",
"nullable": true
},
"payRate": {
"type": "number",
"description": "The pay rate which can be applied to this rate sheet's job orders and assignments",
"format": "double",
"nullable": true
},
"overtimePayRate": {
"type": "number",
"description": "The overtime pay rate which can be applied to this rate sheet's job orders and assignments",
"format": "double",
"nullable": true
},
"doubletimePayRate": {
"type": "number",
"description": "The doubletime pay rate which can be applied to this rate sheet's job orders and assignments",
"format": "double",
"nullable": true
},
"unitPayRate": {
"type": "number",
"description": "The unit pay rate which can be applied to this rate sheet's job orders and assignments",
"format": "double",
"nullable": true
},
"subsPayRate": {
"type": "number",
"description": "The subs pay rate which can be applied to this rate sheet's job orders and assignments",
"format": "double",
"nullable": true
},
"billRate": {
"type": "number",
"description": "The bill rate which can be applied to this rate sheet's job orders and assignments",
"format": "double",
"nullable": true
},
"overtimeBillRate": {
"type": "number",
"description": "The overtime bill rate which can be applied to this rate sheet's job orders and assignments",
"format": "double",
"nullable": true
},
"doubletimeBillRate": {
"type": "number",
"description": "The doubletime bill rate which can be applied to this rate sheet's job orders and assignments",
"format": "double",
"nullable": true
},
"unitBillRate": {
"type": "number",
"description": "The unit bill rate which can be applied to this rate sheet's job orders and assignments",
"format": "double",
"nullable": true
},
"overtimeFactor": {
"type": "number",
"description": "The overtime factor which can be applied to this rate sheet's job orders and assignments",
"format": "double",
"nullable": true
},
"doubletimeFactor": {
"type": "number",
"description": "The doubletime factor which can be applied to this rate sheet's job orders and assignments",
"format": "double",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request for updating a Rate Sheet"
},
"TwApi.Services.RateSheets.Service.Commands.CreateRateSheet.Result": {
"type": "object",
"properties": {
"rateSheetId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"TwApi.Services.RateSheets.Service.Commands.GetRateSheetList.Result": {
"type": "object",
"properties": {
"rateSheetId": {
"type": "string",
"format": "uuid"
},
"customerName": {
"type": "string",
"nullable": true
},
"departmentName": {
"type": "string",
"nullable": true
},
"customerId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"worksite": {
"type": "string",
"nullable": true
},
"worksiteId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"jobTitle": {
"type": "string",
"nullable": true
},
"jobTitleId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"employeeFirstName": {
"type": "string",
"nullable": true
},
"employeeLastName": {
"type": "string",
"nullable": true
},
"employeeId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"branchName": {
"type": "string",
"nullable": true
},
"branchId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"shiftName": {
"type": "string",
"nullable": true
},
"shiftId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"workerCompCode": {
"type": "string",
"nullable": true
},
"workerCompCodeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"hierId": {
"type": "integer",
"format": "int32"
},
"applyRateSheetToCustomerDepartments": {
"type": "boolean"
},
"multiplierCode": {
"type": "string",
"nullable": true
},
"multiplierCodeId": {
"type": "integer",
"format": "int32"
},
"payRate": {
"type": "number",
"format": "double"
},
"overtimePayRate": {
"type": "number",
"format": "double"
},
"doubletimePayRate": {
"type": "number",
"format": "double"
},
"unitPayRate": {
"type": "number",
"format": "double"
},
"subsPayRate": {
"type": "number",
"format": "double"
},
"billRate": {
"type": "number",
"format": "double"
},
"overtimeBillRate": {
"type": "number",
"format": "double"
},
"doubletimeBillRate": {
"type": "number",
"format": "double"
},
"unitBillRate": {
"type": "number",
"format": "double"
},
"overtimeFactor": {
"type": "number",
"format": "double"
},
"doubletimeFactor": {
"type": "number",
"format": "double"
},
"grossProfitPercent": {
"type": "number",
"format": "double"
},
"isActive": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.RateSheets.Service.Commands.GetRateSheetMatchList.Result": {
"type": "object",
"properties": {
"rateSheetId": {
"type": "string",
"format": "uuid"
},
"customerId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"worksiteId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"jobTitleId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"employeeId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"branchId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"shiftId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"workerCompCodeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"hierId": {
"type": "integer",
"format": "int32"
},
"applyRateSheetToCustomerDepartments": {
"type": "boolean"
},
"multiplierCodeId": {
"type": "integer",
"format": "int32"
},
"payRate": {
"type": "number",
"format": "double"
},
"overtimePayRate": {
"type": "number",
"format": "double"
},
"doubletimePayRate": {
"type": "number",
"format": "double"
},
"unitPayRate": {
"type": "number",
"format": "double"
},
"subsPayRate": {
"type": "number",
"format": "double"
},
"billRate": {
"type": "number",
"format": "double"
},
"overtimeBillRate": {
"type": "number",
"format": "double"
},
"doubletimeBillRate": {
"type": "number",
"format": "double"
},
"unitBillRate": {
"type": "number",
"format": "double"
},
"overtimeFactor": {
"type": "number",
"format": "double"
},
"doubletimeFactor": {
"type": "number",
"format": "double"
},
"grossProfitPercent": {
"type": "number",
"format": "double"
},
"priority": {
"type": "integer",
"format": "int32"
},
"ranking": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.RateSheets.Service.Commands.RateSheetDetailsQuery.Result": {
"type": "object",
"properties": {
"rateSheetId": {
"type": "string",
"format": "uuid"
},
"customerName": {
"type": "string",
"nullable": true
},
"departmentName": {
"type": "string",
"nullable": true
},
"customerId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"worksite": {
"type": "string",
"nullable": true
},
"worksiteId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"jobTitle": {
"type": "string",
"nullable": true
},
"jobTitleId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"employeeFirstName": {
"type": "string",
"nullable": true
},
"employeeLastName": {
"type": "string",
"nullable": true
},
"employeeId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"branchName": {
"type": "string",
"nullable": true
},
"branchId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"shiftName": {
"type": "string",
"nullable": true
},
"shiftId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"workerCompCode": {
"type": "string",
"nullable": true
},
"workerCompCodeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"hierId": {
"type": "integer",
"format": "int32"
},
"applyRateSheetToCustomerDepartments": {
"type": "boolean"
},
"multiplierCode": {
"type": "string",
"nullable": true
},
"multiplierCodeId": {
"type": "integer",
"format": "int32"
},
"payRate": {
"type": "number",
"format": "double"
},
"overtimePayRate": {
"type": "number",
"format": "double"
},
"doubletimePayRate": {
"type": "number",
"format": "double"
},
"unitPayRate": {
"type": "number",
"format": "double"
},
"subsPayRate": {
"type": "number",
"format": "double"
},
"billRate": {
"type": "number",
"format": "double"
},
"overtimeBillRate": {
"type": "number",
"format": "double"
},
"doubletimeBillRate": {
"type": "number",
"format": "double"
},
"unitBillRate": {
"type": "number",
"format": "double"
},
"overtimeFactor": {
"type": "number",
"format": "double"
},
"doubletimeFactor": {
"type": "number",
"format": "double"
},
"grossProfitPercent": {
"type": "number",
"format": "double"
},
"isActive": {
"type": "boolean"
},
"sutaJurisId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"sutaJuris": {
"type": "string",
"nullable": true
},
"burdenRate": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"TwApi.Services.Reports.API.Models.CreateFavoriteReportRequest": {
"required": [
"reportId"
],
"type": "object",
"properties": {
"reportId": {
"type": "string",
"description": "",
"format": "uuid"
}
},
"additionalProperties": false,
"description": ""
},
"TwApi.Services.Reports.Service.Commands.KpiReportParameters.Result": {
"type": "object",
"properties": {
"reportParameterId": {
"type": "string",
"format": "uuid"
},
"reportParameter": {
"type": "string",
"nullable": true
},
"reportParameterDisplayName": {
"type": "string",
"nullable": true
},
"dataType": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Reports.Service.Commands.KpiReports.Result": {
"type": "object",
"properties": {
"reportId": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"reportType": {
"type": "string",
"nullable": true
},
"reportTypeId": {
"type": "integer",
"format": "int32"
},
"reportColor": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Reports.Service.Commands.ReportsQuery.Result": {
"type": "object",
"properties": {
"reportId": {
"type": "string",
"format": "uuid"
},
"report": {
"type": "string",
"nullable": true
},
"reportGroupId": {
"type": "string",
"format": "uuid"
},
"reportGroup": {
"type": "string",
"nullable": true
},
"reportType": {
"type": "string",
"nullable": true
},
"reportTypeId": {
"type": "integer",
"format": "int32"
},
"reportDescription": {
"type": "string",
"nullable": true
},
"reportPath": {
"type": "string",
"nullable": true
},
"isFavorite": {
"type": "boolean"
},
"originTypeIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Reports.Service.Commands.RunKpiReport.Result": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": { },
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Reports.Service.Models.KpiReportParameter": {
"type": "object",
"properties": {
"reportParameterId": {
"type": "string",
"format": "uuid"
},
"value": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Reports.Service.Models.RunKpiReportRequest": {
"type": "object",
"properties": {
"parameters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Reports.Service.Models.KpiReportParameter"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.API.Models.AddFavoriteSavedSearchRequest": {
"required": [
"savedSearchId"
],
"type": "object",
"properties": {
"savedSearchId": {
"type": "string",
"description": "The Id of the Saved Search. A list of saved searches can be found a the search/{originTypeId/searches endpoint.",
"format": "uuid"
}
},
"additionalProperties": false,
"description": "A request to add a saved search to the user's favorites list."
},
"TwApi.Services.Searches.API.Models.BackgroundCheckSearchRequest": {
"type": "object",
"properties": {
"employeeId": {
"type": "integer",
"description": "Optional filter on the Id of the employee.",
"format": "int64",
"nullable": true
},
"backgroundCheckId": {
"type": "string",
"description": "Optional filter on the Id of the background check.",
"format": "uuid",
"nullable": true
},
"firstName": {
"type": "string",
"description": "Optional filter on the first name of the employee.",
"nullable": true
},
"lastName": {
"type": "string",
"description": "Optional filter on the last name of the employee.",
"nullable": true
},
"governmentPersonalId": {
"type": "string",
"description": "Optional filter on the government personal Id.",
"nullable": true
},
"backgroundCheckVendorId": {
"type": "integer",
"description": "Optional filter on the Id of background check vendor.",
"format": "int32",
"nullable": true
},
"backgroundCheckStatusId": {
"type": "integer",
"description": "Optional filter on the background check status.",
"format": "int32",
"nullable": true
},
"createdByServiceRepId": {
"type": "integer",
"description": "Optional filter on the Id of the service rep who created the background check request.",
"format": "int32",
"nullable": true
},
"branchId": {
"type": "integer",
"description": "Optional filter on the Id of the employee branch.",
"format": "int32",
"nullable": true
},
"isReviewed": {
"type": "boolean",
"description": "Optional filter used to filter out background checks which are reviewed.",
"nullable": true
},
"orderBy": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.OrderByColumn"
},
"description": "Criteria to allow for the control of the Order by Column. Use the column name of the results to locate available fields.",
"nullable": true
},
"skip": {
"type": "integer",
"description": "The number of items to skip. Used for paging.",
"format": "int32"
},
"take": {
"type": "integer",
"description": "The number of items to take. Used for paging.",
"format": "int32"
}
},
"additionalProperties": false,
"description": "Request object for Background Checks Search"
},
"TwApi.Services.Searches.API.Models.CreateDynamicSearchRequest": {
"required": [
"name",
"searchCriteria"
],
"type": "object",
"properties": {
"name": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "A name for the saved search."
},
"description": {
"type": "string",
"description": "A description of the saved search.",
"nullable": true
},
"searchCriteria": {
"description": "The search criteria object that contains all the rules and groups that make up the search are searched and returned.\r\nThis is the same search criteria object passed into the API to perform a search. The only change is that rules can be\r\nleft without a value thus allowing the system form them to be entered the next time the search is performed."
},
"sortByColumns": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Models.DynamicSearchSortColumn"
},
"description": "The list of columns the result should be sorted by. This is the same list that is passed into the API to perform a search.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to save a dynamic search's criteria and sorting for later use by the user or others if distributed to service rep\r\nteams."
},
"TwApi.Services.Searches.API.Models.EditDynamicSearchTeamsRequest": {
"required": [
"teamIds"
],
"type": "object",
"properties": {
"teamIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "The list of teams to which the search will be distributed. The omission of a team currently visible to the service rep\r\nwill result in that team being removed from the distribution list if that team is currently linked. In essence, this replaces\r\nthe current distribution list with the list specified in the request.\r\n\r\nA list of TeamIds can be found at Datalists/ServiceRepTeams"
}
},
"additionalProperties": false,
"description": "A request to update what teams a saved search can be used by."
},
"TwApi.Services.Searches.API.Models.PerformDynamicSearchRequest": {
"required": [
"searchCriteria",
"sortByColumns"
],
"type": "object",
"properties": {
"ignoreCachedResults": {
"type": "boolean",
"description": "Used to indicate whether or not to take advantage of cached results for quicker responses.\r\nResults for a search are cached for a few minutes to make paging speedy and responsive on\r\ncomplex searches. If set to true, the results will still be cached so future requests can\r\ntake advantage of the speed gains of caching."
},
"searchCriteria": {
"description": "The criteria for the search. Please review the documentation for how to build this object if\r\nyou wish to know more."
},
"sortByColumns": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Models.DynamicSearchSortColumn"
},
"description": "Defines the order of the results. At least one value is required."
},
"skip": {
"type": "integer",
"description": "The number of items to skip. Used for paging.",
"format": "int32"
},
"take": {
"type": "integer",
"description": "The number of items to take. Used for paging.",
"format": "int32"
}
},
"additionalProperties": false,
"description": "A request to perform a dynamic search."
},
"TwApi.Services.Searches.API.Models.UpdateDynamicSearchRequest": {
"required": [
"name",
"searchCriteria"
],
"type": "object",
"properties": {
"name": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "A name for the saved search."
},
"description": {
"type": "string",
"description": "A description of the saved search.",
"nullable": true
},
"searchCriteria": {
"description": "The search criteria object that contains all the rules and groups that make up the search are searched and returned.\r\nThis is the same search criteria object passed into the API to perform a search. The only change is that rules can be\r\nleft without a value thus allowing the system form them to be entered the next time the search is performed."
},
"sortByColumns": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Models.DynamicSearchSortColumn"
},
"description": "The list of columns the result should be sorted by. This is the same list that is passed into the API to perform a search.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to update a saved search."
},
"TwApi.Services.Searches.Service.Commands.ContactsSearchQuery.Result": {
"type": "object",
"properties": {
"contactId": {
"type": "integer",
"format": "int32"
},
"lastName": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"customerId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"customerName": {
"type": "string",
"nullable": true
},
"departmentName": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"status": {
"type": "string",
"nullable": true
},
"officePhone": {
"type": "string",
"nullable": true
},
"emailAddress": {
"type": "string",
"nullable": true
},
"branchName": {
"type": "string",
"nullable": true
},
"serviceRep": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.ContractsSearch.Result": {
"type": "object",
"properties": {
"contractId": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string",
"nullable": true
},
"customerId": {
"type": "integer",
"format": "int64"
},
"customerName": {
"type": "string",
"nullable": true
},
"departmentName": {
"type": "string",
"nullable": true
},
"primaryContactId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"primaryContactFirstName": {
"type": "string",
"nullable": true
},
"primaryContactLastName": {
"type": "string",
"nullable": true
},
"notes": {
"type": "string",
"nullable": true
},
"contractLength": {
"type": "number",
"format": "double",
"nullable": true
},
"contractLengthTypeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"contractLengthType": {
"type": "string",
"nullable": true
},
"contractStatusId": {
"type": "integer",
"format": "int32"
},
"contractStatus": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"dateContractSigned": {
"type": "string",
"format": "date-time",
"nullable": true
},
"startDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"endDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"contractCategoryId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"contractCategory": {
"type": "string",
"nullable": true
},
"ownedByServiceRepId": {
"type": "integer",
"format": "int32"
},
"ownedByServiceRep": {
"type": "string",
"nullable": true
},
"lastModifiedByServiceRepId": {
"type": "integer",
"format": "int32"
},
"lastModifiedByServiceRep": {
"type": "string",
"nullable": true
},
"createdByServiceRepId": {
"type": "integer",
"format": "int32"
},
"createdByServiceRep": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.CustomersSearchQuery.Result": {
"type": "object",
"properties": {
"customerId": {
"type": "integer",
"format": "int64"
},
"customerName": {
"type": "string",
"nullable": true
},
"departmentName": {
"type": "string",
"nullable": true
},
"branchName": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"status": {
"type": "string",
"nullable": true
},
"officePhone": {
"type": "string",
"nullable": true
},
"municipality": {
"type": "string",
"nullable": true
},
"region": {
"type": "string",
"nullable": true
},
"serviceRep": {
"type": "string",
"nullable": true
},
"salesContact": {
"type": "string",
"nullable": true
},
"salesContactId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"accountManagerServiceRepId": {
"type": "integer",
"format": "int32"
},
"accountManagerServiceRep": {
"type": "string",
"nullable": true
},
"accountManagerServiceRepFullName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.Dynamic.SavedSearches.CreateSavedSearchCommand.Result": {
"type": "object",
"properties": {
"savedSearchId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.Dynamic.SavedSearches.SavedSearchListQuery.SavedSearch": {
"type": "object",
"properties": {
"savedSearchId": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"isDefaultSearch": {
"type": "boolean"
},
"searchCriteria": {
"nullable": true
},
"sortByColumns": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Models.DynamicSearchSortColumn"
},
"nullable": true
},
"ownedByServiceRepId": {
"type": "integer",
"format": "int32"
},
"ownedByServiceRep": {
"type": "string",
"nullable": true
},
"canDeleteSearch": {
"type": "boolean"
},
"canEditSearch": {
"type": "boolean"
},
"isPrivateSearch": {
"type": "boolean"
},
"isFavorite": {
"type": "boolean"
},
"dateCreated": {
"type": "string",
"format": "date-time"
},
"summary": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.Dynamic.SavedSearches.SavedSearchTeamList.Result": {
"type": "object",
"properties": {
"teamId": {
"type": "integer",
"format": "int32"
},
"team": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.Dynamic.SearchCategoriesQuery.SearchCategory": {
"type": "object",
"properties": {
"categoryId": {
"type": "string",
"format": "uuid"
},
"category": {
"type": "string",
"nullable": true
},
"hierId": {
"type": "integer",
"format": "int32"
},
"originTypeId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.Dynamic.SearchColumnTypeListQuery.SearchColumnType": {
"type": "object",
"properties": {
"type": {
"type": "string",
"nullable": true
},
"operators": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Models.DynamicSearchOperator"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.Dynamic.SearchDatalistQuery.DatalistItem": {
"type": "object",
"properties": {
"key": {
"type": "string",
"nullable": true
},
"value": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.Dynamic.SearchHistoryListQuery.Result": {
"type": "object",
"properties": {
"historyId": {
"type": "integer",
"format": "int64"
},
"originTypeId": {
"type": "integer",
"format": "int32"
},
"searchCriteria": {
"nullable": true
},
"sortByColumns": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Models.DynamicSearchSortColumn"
},
"nullable": true
},
"dateRun": {
"type": "string",
"format": "date-time"
},
"summary": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.EmailSearch.Result": {
"type": "object",
"properties": {
"emailAddress": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"isPrimary": {
"type": "boolean"
},
"originId": {
"type": "integer",
"format": "int64"
},
"originTypeId": {
"type": "integer",
"format": "int32"
},
"branchName": {
"type": "string",
"nullable": true
},
"governmentPersonalId": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.EmployeesSearchQuery.Result": {
"type": "object",
"properties": {
"employeeId": {
"type": "integer",
"format": "int64"
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"branch": {
"type": "string",
"nullable": true
},
"phoneNumber": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"isAssigned": {
"type": "boolean"
},
"lastMessage": {
"type": "string",
"nullable": true
},
"postalCode": {
"type": "string",
"nullable": true
},
"hasResumeOnFile": {
"type": "boolean"
},
"cellPhoneNumber": {
"type": "string",
"nullable": true
},
"emailAddress": {
"type": "string",
"nullable": true
},
"governmentPersonalId": {
"type": "string",
"nullable": true
},
"municipality": {
"type": "string",
"nullable": true
},
"serviceRep": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.EverifyCasesSearchQuery.Response": {
"type": "object",
"properties": {
"caseId": {
"type": "string",
"format": "uuid"
},
"caseNumber": {
"type": "string",
"nullable": true
},
"currentState": {
"type": "string",
"nullable": true
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"assignmentId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"hireDate": {
"type": "string",
"format": "date-time"
},
"dateSubmitted": {
"type": "string",
"format": "date-time",
"nullable": true
},
"closedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"branchId": {
"type": "integer",
"format": "int32"
},
"branchName": {
"type": "string",
"nullable": true
},
"serviceRepId": {
"type": "integer",
"format": "int32"
},
"serviceRepFullName": {
"type": "string",
"nullable": true
},
"eligibilityStatementCode": {
"type": "string",
"nullable": true
},
"eligibilityStatement": {
"type": "string",
"nullable": true
},
"eligibilityStatementDetails": {
"type": "string",
"nullable": true
},
"isClosed": {
"type": "boolean"
},
"canAdministrateCase": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.EverifySearchEligibilityStatementDatalistQuery.Response": {
"type": "object",
"properties": {
"eligibilityStatement": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.JobBoardSearch.Result": {
"type": "object",
"properties": {
"jobOrderId": {
"type": "integer",
"format": "int64"
},
"municipality": {
"type": "string",
"nullable": true
},
"region": {
"type": "string",
"nullable": true
},
"postalCode": {
"type": "string",
"nullable": true
},
"dateOrderTaken": {
"type": "string",
"format": "date-time"
},
"jobTitle": {
"type": "string",
"nullable": true
},
"jobDescription": {
"type": "string",
"nullable": true
},
"jobDescriptionContentType": {
"type": "string",
"nullable": true
},
"category": {
"type": "string",
"nullable": true
},
"orderType": {
"type": "string",
"nullable": true
},
"skills": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"distance": {
"type": "number",
"format": "double"
},
"jobBoardUrl": {
"type": "string",
"nullable": true
},
"payRate": {
"type": "number",
"format": "double",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.JobFeedGetJobs.Result": {
"type": "object",
"properties": {
"jobOrderId": {
"type": "integer",
"format": "int64"
},
"jobTitle": {
"type": "string",
"nullable": true
},
"jobDescription": {
"type": "string",
"nullable": true
},
"jobDescriptionContentType": {
"type": "string",
"nullable": true
},
"orderType": {
"type": "string",
"nullable": true
},
"skills": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"dateOrderTaken": {
"type": "string",
"format": "date-time",
"nullable": true
},
"category": {
"type": "string",
"nullable": true
},
"jobBoardUrl": {
"type": "string",
"nullable": true
},
"orderStatusId": {
"type": "integer",
"format": "int32"
},
"orderStatus": {
"type": "string",
"nullable": true
},
"pay": {
"type": "number",
"format": "double",
"nullable": true
},
"payFrequency": {
"type": "string",
"nullable": true
},
"branchId": {
"type": "integer",
"format": "int32"
},
"branchName": {
"type": "string",
"nullable": true
},
"serviceRepId": {
"type": "integer",
"format": "int32"
},
"serviceRep": {
"type": "string",
"nullable": true
},
"serviceRepFullName": {
"type": "string",
"nullable": true
},
"serviceRepEmail": {
"type": "string",
"nullable": true
},
"address": {
"$ref": "#/components/schemas/TempWorks.TwApi.Common.Models.Address"
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.JobOrdersSearchQuery.Result": {
"type": "object",
"properties": {
"orderId": {
"type": "integer",
"format": "int64"
},
"customerId": {
"type": "integer",
"format": "int64"
},
"customerName": {
"type": "string",
"nullable": true
},
"departmentName": {
"type": "string",
"nullable": true
},
"jobTitle": {
"type": "string",
"nullable": true
},
"orderType": {
"type": "string",
"nullable": true
},
"payRate": {
"type": "number",
"format": "double",
"nullable": true
},
"billRate": {
"type": "number",
"format": "double",
"nullable": true
},
"startDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"orderStatus": {
"type": "string",
"nullable": true
},
"positionsRequired": {
"type": "integer",
"format": "int32"
},
"positionsFilled": {
"type": "integer",
"format": "int32"
},
"workSiteId": {
"type": "integer",
"format": "int32"
},
"worksite": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"branchId": {
"type": "integer",
"format": "int32"
},
"branchName": {
"type": "string",
"nullable": true
},
"serviceRepId": {
"type": "integer",
"format": "int32"
},
"serviceRep": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.JobsSearchQuery.Result": {
"type": "object",
"properties": {
"orderId": {
"type": "integer",
"format": "int64"
},
"municipality": {
"type": "string",
"nullable": true
},
"region": {
"type": "string",
"nullable": true
},
"postalCode": {
"type": "string",
"nullable": true
},
"dateOrderTaken": {
"type": "string",
"format": "date-time"
},
"jobTitle": {
"type": "string",
"nullable": true
},
"jobDescription": {
"type": "string",
"nullable": true
},
"category": {
"type": "string",
"nullable": true
},
"orderType": {
"type": "string",
"nullable": true
},
"skills": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"distance": {
"type": "integer",
"format": "int32"
},
"jobBoardUrl": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.NearMe.ContactNearMeSearch.Result": {
"type": "object",
"properties": {
"contactId": {
"type": "integer",
"format": "int32"
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"customerId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"customerName": {
"type": "string",
"nullable": true
},
"departmentName": {
"type": "string",
"nullable": true
},
"branchId": {
"type": "integer",
"format": "int32"
},
"branchName": {
"type": "string",
"nullable": true
},
"distance": {
"type": "number",
"format": "double"
},
"distanceUnitId": {
"type": "integer",
"format": "int64"
},
"distanceUnit": {
"type": "string",
"nullable": true
},
"latitude": {
"type": "number",
"format": "double"
},
"longitude": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.NearMe.CustomerNearMeSearch.Result": {
"type": "object",
"properties": {
"customerId": {
"type": "integer",
"format": "int64"
},
"customerName": {
"type": "string",
"nullable": true
},
"departmentName": {
"type": "string",
"nullable": true
},
"branchId": {
"type": "integer",
"format": "int32"
},
"branchName": {
"type": "string",
"nullable": true
},
"distance": {
"type": "number",
"format": "double"
},
"distanceUnitId": {
"type": "integer",
"format": "int64"
},
"distanceUnit": {
"type": "string",
"nullable": true
},
"latitude": {
"type": "number",
"format": "double"
},
"longitude": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.NearMe.CustomerRelatedNearMeSearch.Results": {
"type": "object",
"properties": {
"center": {
"$ref": "#/components/schemas/TempWorks.TwApi.Common.Models.GeoCoordinate"
},
"contacts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.NearMe.ContactNearMeSearch.Result"
},
"nullable": true
},
"customers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.NearMe.CustomerNearMeSearch.Result"
},
"nullable": true
},
"worksites": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.NearMe.WorksiteNearMeSearch.Result"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.NearMe.WorksiteNearMeSearch.Result": {
"type": "object",
"properties": {
"worksiteId": {
"type": "integer",
"format": "int32"
},
"worksite": {
"type": "string",
"nullable": true
},
"customerId": {
"type": "integer",
"format": "int64"
},
"customerName": {
"type": "string",
"nullable": true
},
"departmentName": {
"type": "string",
"nullable": true
},
"branchId": {
"type": "integer",
"format": "int32"
},
"branchName": {
"type": "string",
"nullable": true
},
"distance": {
"type": "number",
"format": "double"
},
"distanceUnitId": {
"type": "integer",
"format": "int64"
},
"distanceUnit": {
"type": "string",
"nullable": true
},
"latitude": {
"type": "number",
"format": "double"
},
"longitude": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.ProspectSearch.Result": {
"type": "object",
"properties": {
"prospectId": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string",
"nullable": true
},
"department": {
"type": "string",
"nullable": true
},
"prospectStatusId": {
"type": "integer",
"format": "int64"
},
"prospectStatus": {
"type": "string",
"nullable": true
},
"municipality": {
"type": "string",
"nullable": true
},
"region": {
"type": "string",
"nullable": true
},
"postalCode": {
"type": "string",
"nullable": true
},
"phoneNumber": {
"type": "string",
"nullable": true
},
"phoneNumberCountryCallingCode": {
"type": "integer",
"format": "int32",
"nullable": true
},
"emailAddress": {
"type": "string",
"nullable": true
},
"primaryProspectContactId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"primaryProspectContactFirstName": {
"type": "string",
"nullable": true
},
"primaryProspectContactLastName": {
"type": "string",
"nullable": true
},
"primaryProspectContactTitle": {
"type": "string",
"nullable": true
},
"dateCreated": {
"type": "string",
"format": "date-time"
},
"dateConvertedToCustomer": {
"type": "string",
"format": "date-time",
"nullable": true
},
"convertedToCustomerId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"convertedToCustomerName": {
"type": "string",
"nullable": true
},
"convertedToDepartmentName": {
"type": "string",
"nullable": true
},
"ownedByServiceRepId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"ownedByServiceRep": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.UniversalEmailSearch.ContactResults": {
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.UniversalEmailSearch.ContactSearchResult"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.UniversalEmailSearch.ContactSearchResult": {
"type": "object",
"properties": {
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"contactId": {
"type": "string",
"nullable": true
},
"customerName": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"officePhone": {
"type": "string",
"nullable": true
},
"contactStatus": {
"type": "string",
"nullable": true
},
"municipality": {
"type": "string",
"nullable": true
},
"region": {
"type": "string",
"nullable": true
},
"branchName": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.UniversalEmailSearch.Contacts": {
"type": "object",
"properties": {
"results": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.UniversalEmailSearch.ContactResults"
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.UniversalEmailSearch.CustomerResults": {
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.UniversalEmailSearch.CustomerSearchResult"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.UniversalEmailSearch.CustomerSearchResult": {
"type": "object",
"properties": {
"customerId": {
"type": "string",
"nullable": true
},
"customerName": {
"type": "string",
"nullable": true
},
"departmentName": {
"type": "string",
"nullable": true
},
"municipality": {
"type": "string",
"nullable": true
},
"region": {
"type": "string",
"nullable": true
},
"branchName": {
"type": "string",
"nullable": true
},
"salesYTD": {
"type": "string",
"nullable": true
},
"officePhone": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"customerStatus": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.UniversalEmailSearch.Customers": {
"type": "object",
"properties": {
"results": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.UniversalEmailSearch.CustomerResults"
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.UniversalEmailSearch.EmployeeResults": {
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.UniversalEmailSearch.EmployeeSearchResult"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.UniversalEmailSearch.EmployeeSearchResult": {
"type": "object",
"properties": {
"employeeId": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"branchName": {
"type": "string",
"nullable": true
},
"phoneNumber": {
"type": "string",
"nullable": true
},
"isAssigned": {
"type": "boolean"
},
"isActive": {
"type": "boolean"
},
"lastMsg": {
"type": "string",
"nullable": true
},
"lastDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"postalCode": {
"type": "string",
"nullable": true
},
"eCurrentAssignment": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.UniversalEmailSearch.Employees": {
"type": "object",
"properties": {
"results": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.UniversalEmailSearch.EmployeeResults"
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.UniversalEmailSearch.Result": {
"type": "object",
"properties": {
"employees": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.UniversalEmailSearch.Employees"
},
"customers": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.UniversalEmailSearch.Customers"
},
"contacts": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.UniversalEmailSearch.Contacts"
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.UniversalPhoneSearch.ContactResults": {
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.UniversalPhoneSearch.ContactSearchResult"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.UniversalPhoneSearch.ContactSearchResult": {
"type": "object",
"properties": {
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"contactId": {
"type": "string",
"nullable": true
},
"customerName": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"phoneNumber": {
"type": "string",
"nullable": true
},
"phoneType": {
"type": "string",
"nullable": true
},
"contactStatus": {
"type": "string",
"nullable": true
},
"municipality": {
"type": "string",
"nullable": true
},
"region": {
"type": "string",
"nullable": true
},
"branchName": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.UniversalPhoneSearch.Contacts": {
"type": "object",
"properties": {
"results": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.UniversalPhoneSearch.ContactResults"
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.UniversalPhoneSearch.CustomerResults": {
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.UniversalPhoneSearch.CustomerSearchResult"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.UniversalPhoneSearch.CustomerSearchResult": {
"type": "object",
"properties": {
"customerId": {
"type": "string",
"nullable": true
},
"customerName": {
"type": "string",
"nullable": true
},
"departmentName": {
"type": "string",
"nullable": true
},
"municipality": {
"type": "string",
"nullable": true
},
"region": {
"type": "string",
"nullable": true
},
"branchName": {
"type": "string",
"nullable": true
},
"salesYTD": {
"type": "string",
"nullable": true
},
"phoneNumber": {
"type": "string",
"nullable": true
},
"phoneType": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"customerStatus": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.UniversalPhoneSearch.Customers": {
"type": "object",
"properties": {
"results": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.UniversalPhoneSearch.CustomerResults"
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.UniversalPhoneSearch.EmployeeResults": {
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.UniversalPhoneSearch.EmployeeSearchResult"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.UniversalPhoneSearch.EmployeeSearchResult": {
"type": "object",
"properties": {
"employeeId": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"branchName": {
"type": "string",
"nullable": true
},
"phoneNumber": {
"type": "string",
"nullable": true
},
"phoneType": {
"type": "string",
"nullable": true
},
"isAssigned": {
"type": "boolean"
},
"isActive": {
"type": "boolean"
},
"lastMsg": {
"type": "string",
"nullable": true
},
"lastDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"postalCode": {
"type": "string",
"nullable": true
},
"eCurrentAssignment": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.UniversalPhoneSearch.Employees": {
"type": "object",
"properties": {
"results": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.UniversalPhoneSearch.EmployeeResults"
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.UniversalPhoneSearch.Result": {
"type": "object",
"properties": {
"employees": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.UniversalPhoneSearch.Employees"
},
"customers": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.UniversalPhoneSearch.Customers"
},
"contacts": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.UniversalPhoneSearch.Contacts"
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.UniversalSearchQuery.AssignmentResults": {
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.UniversalSearchQuery.AssignmentSearchResult"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.UniversalSearchQuery.AssignmentSearchResult": {
"type": "object",
"properties": {
"firstName": {
"type": "string",
"nullable": true
},
"assignmentId": {
"type": "string",
"nullable": true
},
"customerName": {
"type": "string",
"nullable": true
},
"departmentName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"startDate": {
"type": "string",
"format": "date-time"
},
"endDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"jobTitle": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.UniversalSearchQuery.Assignments": {
"type": "object",
"properties": {
"results": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.UniversalSearchQuery.AssignmentResults"
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.UniversalSearchQuery.ContactResults": {
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.UniversalSearchQuery.ContactSearchResult"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.UniversalSearchQuery.ContactSearchResult": {
"type": "object",
"properties": {
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"contactId": {
"type": "string",
"nullable": true
},
"customerName": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"officePhone": {
"type": "string",
"nullable": true
},
"contactStatus": {
"type": "string",
"nullable": true
},
"municipality": {
"type": "string",
"nullable": true
},
"region": {
"type": "string",
"nullable": true
},
"branchName": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.UniversalSearchQuery.Contacts": {
"type": "object",
"properties": {
"results": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.UniversalSearchQuery.ContactResults"
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.UniversalSearchQuery.CustomerResults": {
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.UniversalSearchQuery.CustomerSearchResult"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.UniversalSearchQuery.CustomerSearchResult": {
"type": "object",
"properties": {
"customerId": {
"type": "string",
"nullable": true
},
"customerName": {
"type": "string",
"nullable": true
},
"departmentName": {
"type": "string",
"nullable": true
},
"municipality": {
"type": "string",
"nullable": true
},
"region": {
"type": "string",
"nullable": true
},
"branchName": {
"type": "string",
"nullable": true
},
"salesYTD": {
"type": "string",
"nullable": true
},
"officePhone": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"customerStatus": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.UniversalSearchQuery.Customers": {
"type": "object",
"properties": {
"results": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.UniversalSearchQuery.CustomerResults"
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.UniversalSearchQuery.EmployeeResults": {
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.UniversalSearchQuery.EmployeeSearchResult"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.UniversalSearchQuery.EmployeeSearchResult": {
"type": "object",
"properties": {
"employeeId": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"branchName": {
"type": "string",
"nullable": true
},
"phoneNumber": {
"type": "string",
"nullable": true
},
"isAssigned": {
"type": "boolean"
},
"isActive": {
"type": "boolean"
},
"lastMsg": {
"type": "string",
"nullable": true
},
"lastDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"postalCode": {
"type": "string",
"nullable": true
},
"eCurrentAssignment": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.UniversalSearchQuery.Employees": {
"type": "object",
"properties": {
"results": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.UniversalSearchQuery.EmployeeResults"
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.UniversalSearchQuery.OrderResults": {
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.UniversalSearchQuery.OrderSearchResult"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.UniversalSearchQuery.OrderSearchResult": {
"type": "object",
"properties": {
"orderId": {
"type": "string",
"nullable": true
},
"customerName": {
"type": "string",
"nullable": true
},
"orderType": {
"type": "string",
"nullable": true
},
"jobTitle": {
"type": "string",
"nullable": true
},
"billRate": {
"type": "number",
"format": "double",
"nullable": true
},
"payRate": {
"type": "number",
"format": "double",
"nullable": true
},
"startDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"orderStatus": {
"type": "string",
"nullable": true
},
"positionsRequired": {
"type": "integer",
"format": "int32"
},
"positionsFilled": {
"type": "integer",
"format": "int32"
},
"branchName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.UniversalSearchQuery.Orders": {
"type": "object",
"properties": {
"results": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.UniversalSearchQuery.OrderResults"
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.UniversalSearchQuery.Result": {
"type": "object",
"properties": {
"employees": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.UniversalSearchQuery.Employees"
},
"customers": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.UniversalSearchQuery.Customers"
},
"contacts": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.UniversalSearchQuery.Contacts"
},
"orders": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.UniversalSearchQuery.Orders"
},
"assignments": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Commands.UniversalSearchQuery.Assignments"
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.VendorsSearchQuery.Result": {
"type": "object",
"properties": {
"vendorId": {
"type": "integer",
"format": "int32"
},
"vendorName": {
"type": "string",
"nullable": true
},
"departmentName": {
"type": "string",
"nullable": true
},
"emailAddress": {
"type": "string",
"nullable": true
},
"phoneNumberCountryCallingCode": {
"type": "integer",
"format": "int32"
},
"phoneNumber": {
"type": "string",
"nullable": true
},
"shouldGenerate1099": {
"type": "boolean"
},
"status": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Commands.WebUsersSearchQuery.Result": {
"type": "object",
"properties": {
"webUserId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"username": {
"type": "string",
"nullable": true
},
"originTypeId": {
"type": "integer",
"format": "int32"
},
"originId": {
"type": "integer",
"format": "int64"
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"primaryEmail": {
"type": "string",
"nullable": true
},
"branchName": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Models.DynamicSearchColumn": {
"type": "object",
"properties": {
"columnId": {
"type": "string",
"format": "uuid"
},
"categoryId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"category": {
"type": "string",
"nullable": true
},
"tableId": {
"type": "string",
"format": "uuid"
},
"columnType": {
"type": "string",
"nullable": true
},
"columnName": {
"type": "string",
"nullable": true
},
"columnDisplayName": {
"type": "string",
"nullable": true
},
"returnedColumnName": {
"type": "string",
"nullable": true
},
"returnedColumnType": {
"type": "string",
"nullable": true
},
"datalistId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"isNullable": {
"type": "boolean"
},
"isCustomData": {
"type": "boolean"
},
"isCustomDataJsonArray": {
"type": "boolean"
},
"canBeIncludedInResults": {
"type": "boolean"
},
"originTypeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"originIdColumn": {
"type": "string",
"nullable": true
},
"displayMaskId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"invertBooleanValue": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Models.DynamicSearchOperator": {
"type": "object",
"properties": {
"operatorId": {
"type": "integer",
"format": "int32"
},
"operator": {
"type": "string",
"nullable": true
},
"expectedNumberOfValues": {
"type": "string",
"nullable": true
},
"isComplexOperator": {
"type": "boolean"
},
"isUniquePerColumnInAndGroup": {
"type": "boolean"
},
"makesColumnUniqueInAndGroup": {
"type": "boolean"
},
"isUniquePerColumnInOrGroup": {
"type": "boolean"
},
"makesColumnUniqueInOrGroup": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Models.DynamicSearchResultColumn": {
"type": "object",
"properties": {
"value": {
"nullable": true
},
"originId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"originTypeId": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Models.DynamicSearchResultColumnDefinition": {
"type": "object",
"properties": {
"columnId": {
"type": "string",
"format": "uuid"
},
"displayName": {
"type": "string",
"nullable": true
},
"columnType": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Models.DynamicSearchResults": {
"type": "object",
"properties": {
"columns": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Models.DynamicSearchResultColumnDefinition"
},
"nullable": true
},
"summary": {
"type": "string",
"nullable": true
},
"data": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Models.DynamicSearchResultColumn"
}
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Models.DynamicSearchSortColumn": {
"type": "object",
"properties": {
"columnId": {
"type": "string",
"format": "uuid"
},
"isDescending": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Models.EmployeeRequiredDocument": {
"type": "object",
"properties": {
"employeeRequiredDocumentId": {
"type": "integer",
"format": "int32"
},
"documentId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"isActive": {
"type": "boolean"
},
"requiredDocumentTypeId": {
"type": "integer",
"format": "int32"
},
"requiredDocumentType": {
"type": "string",
"nullable": true
},
"requiredDocumentTypeCategoryId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"requiredDocumentTypeCategory": {
"type": "string",
"nullable": true
},
"requiredDocumentStatus": {
"type": "string",
"nullable": true
},
"requiredDocumentStatusId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"createdDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"expirationdate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"receivedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"issuedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"requestedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"isMissing": {
"type": "boolean"
},
"isExpired": {
"type": "boolean"
},
"isExpiringSoon": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Searches.Service.Models.EmployeeRequiredDocumentSearchResult": {
"type": "object",
"properties": {
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"primaryEmail": {
"type": "string",
"nullable": true
},
"branchId": {
"type": "integer",
"format": "int32"
},
"branchName": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"hireStatus": {
"type": "string",
"nullable": true
},
"requiredDocuments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.Searches.Service.Models.EmployeeRequiredDocument"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Staging.API.Controllers.RequestModels.ConvertStagedEmployeeToEmployeeRequest": {
"type": "object",
"properties": {
"batchJobId": {
"type": "integer",
"description": "Batch Job Id",
"format": "int64",
"example": 42
}
},
"additionalProperties": false,
"description": "Request model for converting staged employee to permanent employee"
},
"TwApi.Services.Staging.API.Models.CreateStagedResumeRequest": {
"required": [
"employeeIds",
"specialReportId"
],
"type": "object",
"properties": {
"employeeIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "List of Employee Id's"
},
"specialReportId": {
"type": "string",
"description": "The report id of the selected template.",
"format": "uuid"
},
"showWorkHistorySection": {
"type": "boolean",
"description": "An optional boolean to include work history section in resume."
},
"showEducationSection": {
"type": "boolean",
"description": "An optional boolean to include education section in resume."
},
"includeAssignmentHistory": {
"type": "boolean",
"description": "An optional boolean to include assignment history section in the resume."
},
"showInterestCodesSection": {
"type": "boolean",
"description": "An optional boolean to include interest codes section in the resume."
},
"fileType": {
"type": "string",
"description": "The type of file to be exported.",
"nullable": true
},
"showContactInfo": {
"type": "boolean",
"description": "A boolean required to include or exclude contact information in the created resume."
},
"imageAlignment": {
"type": "integer",
"description": "an integer used to provide the positioning of the logo in the resume. Defaulting to 1 which is top-left placement.\r\n0 = no logo. \r\n1 = top-left placement.\r\n2 = top-center placement.\r\n3 = top-right placement.",
"format": "int32"
},
"useExistingResumeOnFile": {
"type": "boolean",
"description": "Boolean to determine if resumes should be created if the employee has one on file already."
}
},
"additionalProperties": false,
"description": "Request for creating/retrieving a resume."
},
"TwApi.Services.Staging.API.Models.DeleteStagedEmployeeRequest": {
"type": "object",
"properties": {
"stagedEmployeeIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "List of Staged Employee Id's",
"nullable": true
}
},
"additionalProperties": false,
"description": "Model for deleting a list of staged employees."
},
"TwApi.Services.Staging.API.Models.MergeStagedEmployeeIntoEmployeeRequest": {
"type": "object",
"properties": {
"employeeId": {
"type": "integer",
"description": "Id of employee (target of merge)",
"format": "int64"
},
"mergeAddress": {
"type": "boolean",
"description": "True if address should be merged"
},
"mergeBasicDetails": {
"type": "boolean",
"description": "True if First Name, Middle Name, Last Name should be merged"
},
"mergeContactMethods": {
"type": "boolean",
"description": "True if contact methods should be merged"
},
"mergeDocuments": {
"type": "boolean",
"description": "True if resume from staged employee should be merged"
},
"mergeEducation": {
"type": "boolean",
"description": "True if education records should be merged"
},
"mergeInterestCodes": {
"type": "boolean",
"description": "True if interest codes should be merged"
},
"mergeWorkHistory": {
"type": "boolean",
"description": "True if work history should be merged"
}
},
"additionalProperties": false,
"description": "Request for merging staged employee into employee"
},
"TwApi.Services.Staging.API.Models.UpsertStagedEmployeeContactMethodRequest": {
"type": "object",
"properties": {
"contactMethod": {
"type": "string",
"description": "Contact Method's value such as \"1234567890\" or \"somePerson@gmail.com\"",
"nullable": true,
"example": "\r\n somePerson@gmail.com\r\n "
},
"contactMethodTypeId": {
"type": "integer",
"description": "The type of the contact method. Valid values can be found in the Contact Method Type datalist.",
"format": "int32",
"nullable": true,
"example": 5
},
"importedContactMethodType": {
"type": "string",
"description": "Imported Contact Method Type from the resume",
"nullable": true,
"example": "\r\n Cell\r\n "
},
"proofed": {
"type": "boolean",
"description": "Defaults to false, not proofed",
"nullable": true
}
},
"additionalProperties": false,
"description": "Model for adding or updating a Contact Method for a staged employee."
},
"TwApi.Services.Staging.API.Models.UpsertStagedEmployeeEducationRequest": {
"type": "object",
"properties": {
"contactInformation": {
"type": "string",
"description": "Contact Information of the institution",
"nullable": true,
"example": "\r\n Tim Jameson - 1234567890\r\n "
},
"dateAttendedEnd": {
"type": "string",
"description": "End Date of the education",
"format": "date-time",
"nullable": true,
"example": "\r\n 2012-12-31\r\n "
},
"dateAttendedStart": {
"type": "string",
"description": "Start date of the education",
"format": "date-time",
"nullable": true,
"example": "\r\n 2012-12-31\r\n "
},
"degreeAwarded": {
"type": "string",
"description": "Degree employee was awarded.",
"nullable": true,
"example": "\r\n Master's Degree\r\n "
},
"degreeDate": {
"type": "string",
"description": "Date employee was awarded degree",
"format": "date-time",
"nullable": true,
"example": "\r\n 2021-06-15\r\n "
},
"enrollmentStatus": {
"type": "string",
"description": "Enrollment status of the education",
"nullable": true,
"example": "\r\n active\r\n "
},
"gpa": {
"type": "number",
"description": "GPA rating of the education",
"format": "double",
"nullable": true,
"example": 4
},
"institutionName": {
"type": "string",
"description": "Institution Name of the education",
"nullable": true,
"example": "\r\n Harvard University\r\n "
},
"major": {
"type": "string",
"description": "Education Major",
"nullable": true,
"example": "\r\n Mathematics \r\n "
},
"proofed": {
"type": "boolean",
"description": "Defaults to false, not proofed",
"nullable": true
},
"street1": {
"type": "string",
"description": "Street address of the education institution",
"nullable": true,
"example": "\r\n 123 Summers Lane\r\n "
},
"street2": {
"type": "string",
"description": "2nd line street address of the education institution",
"nullable": true,
"example": "\r\n Apt 42\r\n "
},
"municipality": {
"type": "string",
"description": "Municipality/City of the education institution",
"nullable": true,
"example": "\r\n Lewisville\r\n "
},
"region": {
"type": "string",
"description": "State/Region of the education institution",
"nullable": true,
"example": "\r\n MN\r\n "
},
"countryCode": {
"type": "integer",
"description": "The country code of the institution. Valid Country Codes can be found in the Country Codes Datalist.",
"format": "int32",
"nullable": true,
"example": 840
},
"postalCode": {
"type": "string",
"description": "Postal/Zip code of the education institution",
"nullable": true,
"example": "\r\n 77011\r\n "
},
"other": {
"type": "string",
"description": "Any additional information on the education",
"nullable": true,
"example": "\r\n Graduated with summa cum laude\r\n "
}
},
"additionalProperties": false,
"description": "Model for adding or updating Education for a staged employee."
},
"TwApi.Services.Staging.API.Models.UpsertStagedEmployeeInterestCodeRequest": {
"type": "object",
"properties": {
"interestCodeId": {
"type": "integer",
"description": "Interest Code Id. Valid Interest Codes can be found in the Interest Code Datalist.",
"format": "int32",
"nullable": true,
"example": 109
},
"codeDescription": {
"type": "string",
"description": "Description of Interest Code",
"nullable": true,
"example": "\r\n Forklift\r\n "
},
"proofed": {
"type": "boolean",
"description": "Defaults to false, not proofed",
"nullable": true
},
"years": {
"type": "number",
"description": "The number of years experience the Employee has with this Interest Code.",
"format": "double",
"nullable": true,
"example": 2006
}
},
"additionalProperties": false,
"description": "Model for adding or updating Interest Codes for a staged employee."
},
"TwApi.Services.Staging.API.Models.UpsertStagedEmployeeRequest": {
"type": "object",
"properties": {
"firstName": {
"type": "string",
"description": "The staged employee's first name.",
"nullable": true,
"example": "\r\n Tim\r\n "
},
"middleName": {
"type": "string",
"description": "The staged employee's middle name.",
"nullable": true,
"example": "\r\n Michael\r\n "
},
"lastName": {
"type": "string",
"description": "The staged employee's last name.",
"nullable": true,
"example": "\r\n Ross\r\n "
},
"street1": {
"type": "string",
"description": "The staged employee's Address 1",
"nullable": true,
"example": "\r\n 123 Summers Lane\r\n "
},
"street2": {
"type": "string",
"description": "The staged employee's Address 2",
"nullable": true,
"example": "\r\n Apt 42\r\n "
},
"municipality": {
"type": "string",
"description": "The staged employee's city.",
"nullable": true,
"example": "\r\n Lewisville\r\n "
},
"region": {
"type": "string",
"description": "The staged employee's state",
"nullable": true,
"example": "\r\n MN\r\n "
},
"postalCode": {
"type": "string",
"description": "The staged employee's zip.",
"nullable": true,
"example": "\r\n 77011\r\n "
},
"countryCode": {
"type": "integer",
"description": "The country code of the staged employee. Valid Country Codes can be found in the Country Codes Datalist.",
"format": "int32",
"nullable": true,
"example": 840
},
"howHeardOfDetail": {
"type": "string",
"description": "The staged employee's tracking of how the customer heard of the staffing agency.",
"nullable": true
},
"proofed": {
"type": "boolean",
"description": "Defaults to false, not proofed",
"nullable": true
},
"dateProofed": {
"type": "string",
"description": "Date the staged employee's record was proofed",
"format": "date-time",
"nullable": true
},
"dateEmployeeCreated": {
"type": "string",
"description": "Date the staged employee's record was created",
"format": "date-time",
"nullable": true
},
"duplicatesFound": {
"type": "boolean",
"description": "Flag if this staged employee has a duplicate"
}
},
"additionalProperties": false,
"description": "StagedEmployee"
},
"TwApi.Services.Staging.API.Models.UpsertStagedEmployeeWorkExperienceRequest": {
"required": [
"isFullTime",
"isOkayToContact",
"isPartTime",
"isTemporaryJob"
],
"type": "object",
"properties": {
"duties": {
"type": "string",
"description": "Duties of the work experience",
"nullable": true,
"example": "\r\n Supported six retail locations by directing daily workflow and acting as the main forklift operator.\r\n "
},
"employerName": {
"type": "string",
"description": "Employer of the work experience",
"nullable": true,
"example": "\r\n The Shoe Palace\r\n "
},
"endDate": {
"type": "string",
"description": "End Date of the work experience",
"format": "date-time",
"nullable": true,
"example": "\r\n 2012-04-04\r\n "
},
"isFullTime": {
"type": "boolean",
"description": "Flag if the work experience was full time"
},
"isOkayToContact": {
"type": "boolean",
"description": "Flag if employeer is okay to contact for a reference"
},
"isPartTime": {
"type": "boolean",
"description": "Flag if the work experience was part time"
},
"isTemporaryJob": {
"type": "boolean",
"description": "Flag if the work experience was a temporary position"
},
"jobTitle": {
"type": "string",
"description": "Job Title of the work experience",
"nullable": true,
"example": "\r\n Warehouse Team Leader\r\n "
},
"payRate": {
"type": "string",
"description": "Pay Rate of the work experience",
"nullable": true,
"example": "\r\n 15.75\r\n "
},
"phoneNumber": {
"type": "string",
"description": "Phone Number of the place of work",
"nullable": true,
"example": "\r\n 1234567890\r\n "
},
"reasonForLeaving": {
"type": "string",
"description": "Reason for leaving the job",
"nullable": true,
"example": "\r\n Career change\r\n "
},
"startDate": {
"type": "string",
"description": "Start Date of the work experience",
"format": "date-time",
"nullable": true,
"example": "\r\n 2010-07-29\r\n "
},
"supervisor": {
"type": "string",
"description": "Supervisor reported to",
"nullable": true,
"example": "\r\n Jim Raynor\r\n "
},
"street1": {
"type": "string",
"description": "Street address of the work experience",
"nullable": true,
"example": "\r\n 123 Summers Lane\r\n "
},
"street2": {
"type": "string",
"description": "2nd line street address of the work experience",
"nullable": true,
"example": "\r\n Apt 42\r\n "
},
"municipality": {
"type": "string",
"description": "Municipality/City of the work experience",
"nullable": true,
"example": "\r\n Lewisville\r\n "
},
"region": {
"type": "string",
"description": "State/Region of the work experience",
"nullable": true,
"example": "\r\n MN\r\n "
},
"postalCode": {
"type": "string",
"description": "Postal/Zip code of the work experience",
"nullable": true,
"example": "\r\n 77011\r\n "
},
"proofed": {
"type": "boolean",
"description": "Defaults to false, not proofed",
"nullable": true
}
},
"additionalProperties": false,
"description": "Model for adding or updating Work Experience for a staged employee."
},
"TwApi.Services.Staging.Service.Employee.Commands.CreateStagedEmployeeContactMethod.Result": {
"type": "object",
"properties": {
"stagedEmployeeContactMethodId": {
"type": "integer",
"format": "int64"
}
},
"additionalProperties": false
},
"TwApi.Services.Staging.Service.Employee.Commands.CreateStagedEmployeeEducation.Result": {
"type": "object",
"properties": {
"stagedEmployeeEducationId": {
"type": "integer",
"format": "int64"
}
},
"additionalProperties": false
},
"TwApi.Services.Staging.Service.Employee.Commands.CreateStagedEmployeeInterestCode.Result": {
"type": "object",
"properties": {
"stagedEmployeeInterestCodeId": {
"type": "integer",
"format": "int64"
}
},
"additionalProperties": false
},
"TwApi.Services.Staging.Service.Employee.Commands.CreateStagedEmployeeWorkExperience.Result": {
"type": "object",
"properties": {
"stagedEmployeeWorkExperienceId": {
"type": "integer",
"format": "int64"
}
},
"additionalProperties": false
},
"TwApi.Services.Staging.Service.Employee.Commands.DeleteStagedEmployeesSetup.Result": {
"type": "object",
"properties": {
"batchJobId": {
"type": "integer",
"format": "int64"
}
},
"additionalProperties": false
},
"TwApi.Services.Staging.Service.Employee.Commands.StagedEmployeeDuplicatesQuery.Result": {
"type": "object",
"properties": {
"employeeId": {
"type": "integer",
"format": "int64"
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"emailMatch": {
"type": "boolean"
},
"addressMatch": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Staging.Service.Employee.Models.ResumeDefaultSettings": {
"required": [
"branchId",
"isEmployeeActive",
"serviceRepId"
],
"type": "object",
"properties": {
"serviceRepId": {
"type": "integer",
"format": "int32"
},
"orderTypeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"employeeStatusId": {
"type": "string",
"nullable": true
},
"howHeardOfId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"howHeardOfDetail": {
"type": "string",
"nullable": true
},
"employmentCategoryId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"branchId": {
"type": "integer",
"format": "int32"
},
"isEmployeeActive": {
"type": "boolean"
},
"washedStatusId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"messageActionId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"loggedMessage": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Staging.Service.Employee.Models.StagedEmployee": {
"type": "object",
"properties": {
"stagedEmployeeId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"middleName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"hierId": {
"type": "integer",
"format": "int32"
},
"street1": {
"type": "string",
"nullable": true
},
"street2": {
"type": "string",
"nullable": true
},
"municipality": {
"type": "string",
"nullable": true
},
"region": {
"type": "string",
"nullable": true
},
"postalCode": {
"type": "string",
"nullable": true
},
"countryCode": {
"type": "integer",
"format": "int32",
"nullable": true
},
"dateEmployeeCreated": {
"type": "string",
"format": "date-time",
"nullable": true
},
"dateImported": {
"type": "string",
"format": "date-time",
"nullable": true
},
"dateProofed": {
"type": "string",
"format": "date-time",
"nullable": true
},
"howHeardOfDetail": {
"type": "string",
"nullable": true
},
"importedByServiceRepId": {
"type": "integer",
"format": "int32"
},
"proofed": {
"type": "boolean"
},
"duplicatesFound": {
"type": "boolean"
},
"isCreatedFromParsedResume": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeContactMethod": {
"type": "object",
"properties": {
"stagedEmployeeContactMethodId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"contactMethod": {
"type": "string",
"nullable": true
},
"contactMethodTypeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"contactMethodType": {
"type": "string",
"nullable": true
},
"contactMethodGroupTypeId": {
"type": "integer",
"format": "int32"
},
"importedContactMethodType": {
"type": "string",
"nullable": true
},
"proofed": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeEducation": {
"type": "object",
"properties": {
"stagedEmployeeEducationId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"addressStandardized": {
"type": "string",
"format": "date-time",
"nullable": true
},
"contactInformation": {
"type": "string",
"nullable": true
},
"dateAttendedEnd": {
"type": "string",
"format": "date-time",
"nullable": true
},
"dateAttendedStart": {
"type": "string",
"format": "date-time",
"nullable": true
},
"degreeAwarded": {
"type": "string",
"nullable": true
},
"degreeDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"enrollmentStatus": {
"type": "string",
"nullable": true
},
"gpa": {
"type": "number",
"format": "double",
"nullable": true
},
"institutionName": {
"type": "string",
"nullable": true
},
"major": {
"type": "string",
"nullable": true
},
"proofed": {
"type": "boolean"
},
"street1": {
"type": "string",
"nullable": true
},
"street2": {
"type": "string",
"nullable": true
},
"municipality": {
"type": "string",
"nullable": true
},
"region": {
"type": "string",
"nullable": true
},
"countryCode": {
"type": "integer",
"format": "int32",
"nullable": true
},
"postalCode": {
"type": "string",
"nullable": true
},
"other": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeInterestCode": {
"type": "object",
"properties": {
"stagedEmployeeInterestCodeId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"interestCodeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"codeDescription": {
"type": "string",
"nullable": true
},
"proofed": {
"type": "boolean"
},
"years": {
"type": "number",
"format": "double",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeWithStatus": {
"type": "object",
"properties": {
"stagedEmployeeId": {
"type": "integer",
"format": "int64"
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"region": {
"type": "string",
"nullable": true
},
"postalCode": {
"type": "string",
"nullable": true
},
"proofed": {
"type": "boolean"
},
"docId": {
"type": "integer",
"format": "int32"
},
"docName": {
"type": "string",
"nullable": true
},
"batchJobType": {
"type": "string",
"nullable": true
},
"batchJobItemStatusId": {
"type": "integer",
"format": "int32"
},
"duplicatesFound": {
"type": "boolean"
},
"itemHasFailed": {
"type": "boolean"
},
"itemStatusInformation": {
"type": "string",
"nullable": true
},
"importedByServiceRepId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Staging.Service.Employee.Models.StagedEmployeeWorkExperience": {
"type": "object",
"properties": {
"stagedEmployeeWorkExperienceId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"duties": {
"type": "string",
"nullable": true
},
"employerName": {
"type": "string",
"nullable": true
},
"endDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"isFullTime": {
"type": "boolean"
},
"isOkayToContact": {
"type": "boolean"
},
"isPartTime": {
"type": "boolean"
},
"isTemporaryJob": {
"type": "boolean"
},
"jobTitle": {
"type": "string",
"nullable": true
},
"payRate": {
"type": "string",
"nullable": true
},
"phoneNumber": {
"type": "string",
"nullable": true
},
"reasonForLeaving": {
"type": "string",
"nullable": true
},
"startDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"supervisor": {
"type": "string",
"nullable": true
},
"street1": {
"type": "string",
"nullable": true
},
"street2": {
"type": "string",
"nullable": true
},
"municipality": {
"type": "string",
"nullable": true
},
"region": {
"type": "string",
"nullable": true
},
"postalCode": {
"type": "string",
"nullable": true
},
"proofed": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.System.API.Controllers.CustomContent.RequestModels.CardForPageRequest": {
"required": [
"cardId"
],
"type": "object",
"properties": {
"cardId": {
"type": "integer",
"description": "The identifier of the card which has to be assigned to the page.",
"format": "int32"
},
"shouldFillPage": {
"type": "boolean",
"description": "Requires the card to fill the whole page. If the card fills the whole page no other cards are allowed."
}
},
"additionalProperties": false,
"description": "Request model to assign a card to a page."
},
"TwApi.Services.System.API.Controllers.CustomContent.RequestModels.CreateCardRequest": {
"required": [
"cardType",
"hierId",
"isPublished",
"name",
"originTypeId",
"size"
],
"type": "object",
"properties": {
"cardType": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "This is the cardId of the Beyond component. Example: \"iFrameCard\""
},
"name": {
"maxLength": 64,
"minLength": 1,
"type": "string",
"description": "The name of the card."
},
"originTypeId": {
"type": "integer",
"description": "The origin type to which the card will be available. Supported origin types are 1 (Employee), 2 (Customer), 3 (Contact), 8 (Order), and 14 (Assignment).",
"format": "int32"
},
"hierId": {
"type": "integer",
"description": "The top level hierarchy levels to which the card will be available.\r\nThe card will be available to the given hierarchy level and the ones below it in the same node.\r\nExample: If the card is created on entity level,\r\nwhere the entity level is between the subsystem and the branches,\r\nthe card will be visible for users who are on all the branches bellow the entity and the given entity itself.",
"format": "int32"
},
"size": {
"$ref": "#/components/schemas/TwApi.Common.Enums.CardSize"
},
"isPublished": {
"type": "boolean",
"description": "If IsPublished = false then the card is visible only for its creator.\r\nIf IsPublished = true then the card is visible for all servicereps under the hierarchy."
},
"props": {
"description": "Card specific properties. Example: Url for iFrameCards.",
"nullable": true
}
},
"additionalProperties": false,
"description": "The request model to create a card."
},
"TwApi.Services.System.API.Controllers.CustomContent.RequestModels.CreatePageRequest": {
"required": [
"cards",
"hierId",
"isPublished",
"name",
"originTypeId"
],
"type": "object",
"properties": {
"name": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "The name of the page."
},
"originTypeId": {
"type": "integer",
"description": "The origin type to which the page will be available to. Supported origin types are 1 (Employee), 2 (Customer), 3 (Contact), 8 (Order), and 14 (Assignment).",
"format": "int32"
},
"hierId": {
"type": "integer",
"description": "The top level hierarchy levels to which the page will be available to.\r\nThe page will be available to the given hierarchy level and the ones below it in the same node.\r\nExample: If the card is created on entity level,\r\nwhere the entity level is between the subsystem and the branches,\r\nthe page will be visible for users who are on all the branches bellow the entity and the given entity itself.",
"format": "int32"
},
"isPublished": {
"type": "boolean",
"description": "If IsPublished = false then the page is visible only for its creator and for ServiceReps\r\nat higher levels directly up the hierarchy tree.\r\nIf IsPublished = true then the card is visible for all servicereps at the current level\r\nas well as those at a sub-level of the servicerep's hierarchy level."
},
"cards": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.CustomContent.RequestModels.CardForPageRequest"
},
"description": "Cards to be assigned to the page. The cards have to be on the same level of the page or above it."
}
},
"additionalProperties": false,
"description": "The request model to create a page."
},
"TwApi.Services.System.API.Controllers.CustomContent.RequestModels.UpdateCardRequest": {
"required": [
"name",
"size"
],
"type": "object",
"properties": {
"name": {
"maxLength": 64,
"minLength": 1,
"type": "string",
"description": "The name of the card."
},
"size": {
"$ref": "#/components/schemas/TwApi.Common.Enums.CardSize"
},
"props": {
"description": "Card specific properties. Example: Url for iFrameCards.",
"nullable": true
}
},
"additionalProperties": false,
"description": "The request model to update a card."
},
"TwApi.Services.System.API.Controllers.CustomContent.RequestModels.UpdatePageRequest": {
"required": [
"cards",
"hierId",
"name",
"originTypeId"
],
"type": "object",
"properties": {
"name": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "The name of the page."
},
"originTypeId": {
"type": "integer",
"description": "The origin type to which the page will be available to. Supported origin types are 1 (Employee), 2 (Customer), 3 (Contact), 8 (Order), and 14 (Assignment).\r\nThe origin type will not be updated, it's used for validation only.",
"format": "int32"
},
"hierId": {
"type": "integer",
"description": "The top level hierarchy levels to which the page will be available to.\r\nThe page will be available to the given hierarchy level and the ones below it in the same node.\r\nExample: If the card is created on entity level,\r\nwhere the entity level is between the subsystem and the branches,\r\nthe page will be visible for users who are on all the branches bellow the entity and the given entity itself.\r\nThe hierarchy will not be updated, it's used for validation only.",
"format": "int32"
},
"cards": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Controllers.CustomContent.RequestModels.CardForPageRequest"
},
"description": "Cards to be assigned to the page. The cards have to be on the same level of the page or above it.\r\nExisting cards will be replaced with the new list of cards."
}
},
"additionalProperties": false,
"description": "The update page request."
},
"TwApi.Services.System.API.Controllers.Hotlists.RequestModels.AddMembersToHotlistRequest": {
"type": "object",
"properties": {
"addOnTop": {
"type": "boolean",
"description": "Whether the new members should be added on top or bottom of the hotlist."
},
"originIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "A list of origin ids to be added to the hotlist.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Add members to a hotlist request model."
},
"TwApi.Services.System.API.Controllers.Hotlists.RequestModels.BulkUpdateHotlistEmployeeMembersRequest": {
"required": [
"hotlistMemberIds"
],
"type": "object",
"properties": {
"hotlistStepId": {
"type": "integer",
"description": "The candidate status (hotlist step) id. It will be applied to members. If null is passed the existing value will not be changed.",
"format": "int32",
"nullable": true
},
"note": {
"type": "string",
"description": "The note. It will be applied to all members. If null is passed the existing value will not be changed.",
"nullable": true
},
"hotlistMemberIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "A list with all employee members to be updated."
}
},
"additionalProperties": false,
"description": "The request model to bulk update employee members."
},
"TwApi.Services.System.API.Controllers.Hotlists.RequestModels.CreateHotlistRequest": {
"required": [
"description",
"name",
"originTypeId"
],
"type": "object",
"properties": {
"name": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "The name of the static list."
},
"description": {
"maxLength": 500,
"minLength": 0,
"type": "string",
"description": "The description of the static list."
},
"originTypeId": {
"type": "integer",
"description": "The origin type of the members in the static list.",
"format": "int32"
},
"isPublic": {
"type": "boolean",
"description": "Determines whether the static is public."
},
"sharedUsersCanEdit": {
"type": "boolean",
"description": "Determines whether users or team member share recipients of this hotlist can edit the Name or Description, or manage hotlist members."
},
"sharedWithServiceRepIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "Users with the specified Service Rep Ids will be able to see this Hotlist. Valid values can be found at `Hotlists/AvailableServiceReps`.",
"nullable": true
},
"sharedWithServiceRepTeamIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "Users in the teams with the specified Team Ids will be able to see this Hotlist. Valid values can be found at `Hotlists/AvailableTeams`.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Request model for creating a new hotlist of type static list."
},
"TwApi.Services.System.API.Controllers.Hotlists.RequestModels.UpdateHotlistContactMemberRequest": {
"type": "object",
"properties": {
"note": {
"type": "string",
"description": "The note (contact memo).",
"nullable": true
},
"position": {
"maximum": 2147483647,
"minimum": 1,
"type": "integer",
"description": "The position of the member in the hotlist.",
"format": "int32"
}
},
"additionalProperties": false,
"description": "The request model to update a hotlist contact member."
},
"TwApi.Services.System.API.Controllers.Hotlists.RequestModels.UpdateHotlistCustomerMemberRequest": {
"type": "object",
"properties": {
"note": {
"maxLength": 4000,
"minLength": 0,
"type": "string",
"description": "The note.",
"nullable": true
},
"position": {
"maximum": 2147483647,
"minimum": 1,
"type": "integer",
"description": "The position of the member in the hotlist.",
"format": "int32"
}
},
"additionalProperties": false,
"description": "The request model to update a hotlist customer member."
},
"TwApi.Services.System.API.Controllers.Hotlists.RequestModels.UpdateHotlistEmployeeMemberRequest": {
"type": "object",
"properties": {
"hotlistStepId": {
"type": "integer",
"description": "The candidate status (hotlist step) id.",
"format": "int32",
"nullable": true
},
"note": {
"type": "string",
"description": "The note.",
"nullable": true
},
"position": {
"maximum": 2147483647,
"minimum": 1,
"type": "integer",
"description": "The position of the member in the hotlist.",
"format": "int32"
}
},
"additionalProperties": false,
"description": "The request model to update a hotlist employee member."
},
"TwApi.Services.System.API.Controllers.Hotlists.RequestModels.UpdateHotlistRequest": {
"required": [
"description",
"name"
],
"type": "object",
"properties": {
"name": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "The name of the static list."
},
"description": {
"maxLength": 500,
"minLength": 0,
"type": "string",
"description": "The description of the static list."
},
"isPublic": {
"type": "boolean",
"description": "Determines whether the hotlist (static list) is public. \r\nThis parameter is deprecated on this endpoint, and the \"PUT {hotlistId:guid}/share\" \r\nendpoint should be used instead for setting this value.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request model to update hotlist."
},
"TwApi.Services.System.API.Controllers.Hotlists.RequestModels.UpdateHotlistShareSettingsRequest": {
"required": [
"isPublic",
"sharedUsersCanEdit"
],
"type": "object",
"properties": {
"isPublic": {
"type": "boolean",
"description": "Determines whether the hotlist (static list) is public."
},
"sharedUsersCanEdit": {
"type": "boolean",
"description": "Determines whether users that the hotlist was shared with (non-owners) can edit the hotlist details and members."
},
"sharedWithServiceRepIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "Represents a lists of SRIdents that the hotlist has been shared with. Valid values can be found at `Hotlists/AvailableServiceReps`.",
"nullable": true
},
"sharedWithServiceRepTeamIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "Represents a lists of service rep team Ids that the hotlist has been shared with. Valid values can be found at `Hotlists/AvailableTeams`.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request model to update which users a hotlist is shared with."
},
"TwApi.Services.System.API.Controllers.Hotlists.RequestModels.ValidateHotlistMembersRequest": {
"type": "object",
"properties": {
"originIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "A list of origin ids to validate.",
"nullable": true
},
"originTypeId": {
"type": "integer",
"description": "The origin type of the referenced entity.",
"format": "int32"
}
},
"additionalProperties": false,
"description": "Validate hotlist members request model."
},
"TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateDocumentTypeLinkRequest": {
"type": "object",
"properties": {
"documentTypeId": {
"type": "integer",
"description": "The Id of the document type. A list of document types can be found at datalists/documentTypes",
"format": "int32"
},
"canRead": {
"type": "boolean",
"description": "Indicates whether or not users in the security group will be able to see and view documents of the specified\r\ntype."
},
"canWrite": {
"type": "boolean",
"description": "Indicates whether or not users in the security group will be able to create documents of the specified type."
},
"canDelete": {
"type": "boolean",
"description": "Indicates whether or not users in the security group will be able to delete documents of the specified type."
}
},
"additionalProperties": false,
"description": "A request to add a document type to a security group."
},
"TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateMessageActionTypeLinkRequest": {
"type": "object",
"properties": {
"messageActionTypeId": {
"type": "string",
"description": "The Id of the message action type. A list of message action types can be found at datalists/messageActionTypes",
"format": "uuid"
},
"canRead": {
"type": "boolean",
"description": "Indicates whether or not users in the security group will be able to see and view message actions of the specified\r\ntype."
},
"canWrite": {
"type": "boolean",
"description": "Indicates whether or not users in the security group will be able to create messages actions of the specified type."
}
},
"additionalProperties": false,
"description": "A request to add a message action type to a security group."
},
"TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupCustomerStatusIdRequest": {
"type": "object",
"properties": {
"customerStatusId": {
"type": "string",
"description": "The Id of the customer status. A list of status can be found at the datalists/customerStatuses endpoint.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to allow a security group access to change a customer from the provided status."
},
"TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupDataExportIdRequest": {
"type": "object",
"properties": {
"exportId": {
"type": "string",
"description": "The Id of the data export. A list of exports can be found at the utilities/dataExport/exports endpoint.",
"format": "uuid"
}
},
"additionalProperties": false,
"description": "A request to allow users with the security group to use the specified Data Export."
},
"TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupKpiReportRequest": {
"required": [
"reportId"
],
"type": "object",
"properties": {
"reportId": {
"type": "string",
"description": "The Id of the KPI report. A list of values can be found at the administration/reports/available endpoint using\r\nthe HierId of the security group the report is being added to.",
"format": "uuid"
}
},
"additionalProperties": false,
"description": "A request to allow a security group access to a specific KPI report."
},
"TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupPropertyPermissionRequest": {
"required": [
"denyRead",
"denyWrite",
"propertyDefinitionId"
],
"type": "object",
"properties": {
"propertyDefinitionId": {
"type": "string",
"description": "the Id of the Property Definition to create the permission.",
"format": "uuid"
},
"denyWrite": {
"type": "boolean",
"description": "True will not allow any members of the security group to write to the property definition.\r\nBy default all security groups have access to all property definitions.\r\nThis value must be true when Deny Read is true. Users are not allowed to write if they cannot read values."
},
"denyRead": {
"type": "boolean",
"description": "True will not allow any members of the security group to read or write to the property definition.\r\nBy default all security groups have access to all property definitions."
}
},
"additionalProperties": false,
"description": "A request to add a property permission to a security group."
},
"TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupReportGroupRequest": {
"required": [
"reportGroupId"
],
"type": "object",
"properties": {
"reportGroupId": {
"type": "string",
"description": "The Id of the report group. A list of values can be found at the administration/reports/reportGroups/available\r\nendpoint using the HierId of the security group the report group is being added to.",
"format": "uuid"
}
},
"additionalProperties": false,
"description": "A request to allow a security group access to all reports within the provided report group."
},
"TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupReportRequest": {
"required": [
"reportId"
],
"type": "object",
"properties": {
"reportId": {
"type": "string",
"description": "The Id of the report. A list of values can be found at the administration/reports/available endpoint using\r\nthe HierId of the security group the report is being added to.",
"format": "uuid"
}
},
"additionalProperties": false,
"description": "A request to allow a security group access to a specific report."
},
"TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.CreateSecurityGroupRequest": {
"required": [
"description",
"hierId",
"name",
"securityGroupTypeId"
],
"type": "object",
"properties": {
"name": {
"maxLength": 100,
"minLength": 1,
"type": "string",
"description": "The name of the security group."
},
"description": {
"maxLength": 1000,
"minLength": 1,
"type": "string",
"description": "A description of the security group."
},
"hierId": {
"type": "integer",
"description": "The HierId the group will be available at. A list of hiers can be found at the datalists/hiers endpoint.",
"format": "int32"
},
"securityGroupTypeId": {
"type": "integer",
"description": "The Id of the type of security group this will be. A list of types can be found at the datalists/securityGroupTypes\r\nendpoint.",
"format": "int32"
}
},
"additionalProperties": false,
"description": "A request to create a new security group."
},
"TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.PermissionRequest": {
"type": "object",
"properties": {
"permissionId": {
"type": "string",
"description": "The Id of the permission to be added. A list of permissions can be found at the datalists/permissions endpoint.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to add a permission to a security group."
},
"TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.UpdateDocumentTypeLinkRequest": {
"type": "object",
"properties": {
"canRead": {
"type": "boolean",
"description": "Indicates whether or not users in the security group will be able to see and view documents of the specified\r\ntype."
},
"canWrite": {
"type": "boolean",
"description": "Indicates whether or not users in the security group will be able to create documents of the specified type."
},
"canDelete": {
"type": "boolean",
"description": "Indicates whether or not users in the security group will be able to delete documents of the specified type."
}
},
"additionalProperties": false,
"description": "A request to update a document type already linked to a security group."
},
"TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.UpdateMessageActionTypeLinkRequest": {
"type": "object",
"properties": {
"canRead": {
"type": "boolean",
"description": "Indicates whether or not users in the security group will be able to see and view message actions of the specified\r\ntype."
},
"canWrite": {
"type": "boolean",
"description": "Indicates whether or not users in the security group will be able to create messages actions of the specified type."
}
},
"additionalProperties": false,
"description": "A request to update a message action type already linked to a security group."
},
"TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.UpdateSecurityGroupBeyondAdvancedPermissionRequest": {
"type": "object",
"properties": {
"cards": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Models.AdvancedPermissionsCard"
},
"description": "The updated card permissions. Any cards not in this list will not be updated.",
"nullable": true
},
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Models.AdvancedPermissionsField"
},
"description": "The updated field permissions. Any fields not in this list will not be updated.",
"nullable": true
},
"forms": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Models.AdvancedPermissionsForm"
},
"description": "The updated form permissions. Any forms not in this list will not be updated.",
"nullable": true
},
"pages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Models.AdvancedPermissionsPage"
},
"description": "The updated page permissions. Any pages not in this list will not be updated.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to update the advanced permissions of a security group"
},
"TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.UpdateSecurityGroupPropertyPermissionRequest": {
"required": [
"denyRead",
"denyWrite",
"propertyDefinitionId"
],
"type": "object",
"properties": {
"propertyDefinitionId": {
"type": "string",
"description": "the Id of the Property Definition to create the permission.",
"format": "uuid"
},
"denyWrite": {
"type": "boolean",
"description": "True will not allow any members of the security group to write to the property definition.\r\nBy default all security groups have access to all property definitions.\r\nThis value must be true when Deny Read is true. Users are not allowed to write if they cannot read values."
},
"denyRead": {
"type": "boolean",
"description": "True will not allow any members of the security group to read or write to the property definition.\r\nBy default all security groups have access to all property definitions."
}
},
"additionalProperties": false,
"description": "A request to update a property permission already on a security group."
},
"TwApi.Services.System.API.Controllers.SecurityGroups.RequestModels.UpdateSecurityGroupRequest": {
"required": [
"description",
"hierId",
"name"
],
"type": "object",
"properties": {
"name": {
"maxLength": 100,
"minLength": 1,
"type": "string",
"description": "The name of the security group."
},
"description": {
"maxLength": 1000,
"minLength": 1,
"type": "string",
"description": "A description of the security group and its purpose."
},
"hierId": {
"type": "integer",
"description": "The place in the hierarchy the security group will be visible from.",
"format": "int32"
}
},
"additionalProperties": false,
"description": "A request to update a security group."
},
"TwApi.Services.System.API.Controllers.ServiceRepTeams.RequestModels.AddSavedSearchToTeamRequest": {
"required": [
"savedSearchId"
],
"type": "object",
"properties": {
"savedSearchId": {
"type": "string",
"description": "The Id of the saved search to distribute. A list of Saved Searches can be found at the search/{originTypeId}/searches\r\nendpoint.",
"format": "uuid"
}
},
"additionalProperties": false,
"description": "A request to add distribute a saved search to a team."
},
"TwApi.Services.System.API.Controllers.Users.RequestModels.CreateBookmarkRequest": {
"type": "object",
"properties": {
"originType": {
"$ref": "#/components/schemas/TwApi.Common.Enums.OriginType"
},
"originId": {
"type": "integer",
"description": "The Id of the record to bookmark.",
"format": "int64",
"nullable": true
},
"route": {
"type": "string",
"description": "The Route to where the bookmark will point to in the system.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to create a new bookmark for the authenticated user."
},
"TwApi.Services.System.API.Controllers.Users.RequestModels.CreateCurrentUserServiceRepTokenRequest": {
"required": [
"allowedScopesCsv",
"description"
],
"type": "object",
"properties": {
"description": {
"minLength": 1,
"type": "string",
"description": "A description for the token"
},
"allowedScopesCsv": {
"minLength": 1,
"type": "string",
"description": "The list of scopes the token should be created with. A list of scopes can be found at the system/scopes endpoint."
},
"expiresUtc": {
"type": "string",
"description": "Optionally set the service rep token expiration to specific date. If not specified, the system will default to 18\r\nmonths from today. Maximum value is 10 years from today.",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to create a service rep token granting another service or program access to the system as if it\r\nwere the calling user."
},
"TwApi.Services.System.API.Controllers.Users.RequestModels.SetUserSecurityGroupRequest": {
"required": [
"securityGroupId"
],
"type": "object",
"properties": {
"securityGroupId": {
"type": "string",
"description": "The Id of the security group. A list of security groups can be found at the securityGroups endpoint. Use the user's\r\nHierIdAllowed to determine what HierId to pass to the query.",
"format": "uuid"
}
},
"additionalProperties": false,
"description": "A request to grant a user membership to a security group."
},
"TwApi.Services.System.API.Controllers.Users.RequestModels.UpdateBookmarkSortOrderRequest": {
"type": "object",
"properties": {
"newSortOrder": {
"type": "integer",
"description": "The new sort order for the bookmark in the list of existing bookmarks.",
"format": "int32"
}
},
"additionalProperties": false,
"description": "A request to update an existing bookmark for the authenticated user."
},
"TwApi.Services.System.API.Controllers.Users.RequestModels.UpdateUserHierarchyRequest": {
"required": [
"branchId",
"hierarchyTypeId"
],
"type": "object",
"properties": {
"branchId": {
"type": "integer",
"description": "The Id of the Branch the user will now be operating at.",
"format": "int32"
},
"hierarchyTypeId": {
"type": "integer",
"description": "The height in the hierarchy the rep will be working from. A list of hierarchy types can be found at the users/hierarchyTypes\r\nendpoint",
"format": "int32"
}
},
"additionalProperties": false,
"description": "A request to update where the user is in the hierarchy. Please note that the availability of data changes with this call."
},
"TwApi.Services.System.API.Controllers.Users.RequestModels.UpdateUserLocalizationSettingsRequest": {
"required": [
"dateFormatId",
"ianaTimeZone",
"localeId",
"timeFormatId"
],
"type": "object",
"properties": {
"ianaTimeZone": {
"minLength": 1,
"type": "string",
"description": "A list of available timezones can be found at the datalists/timezones endpoint."
},
"dateFormatId": {
"type": "integer",
"description": "A list of available date formats can be found at the datalists/dateFormats endpoint.",
"format": "int32"
},
"timeFormatId": {
"type": "integer",
"description": "A list of available time formats can be found at the datalists/timeFormats endpoint.",
"format": "int32"
},
"localeId": {
"minLength": 1,
"type": "string",
"description": "A list of available locales can be found at the datalists/locales endpoint."
}
},
"additionalProperties": false,
"description": "A request to update the user's localization settings"
},
"TwApi.Services.System.API.Models.AddressToStandardize": {
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"maxLength": 40,
"minLength": 0,
"type": "string",
"description": "Used to match up the address with its response as multiple addresses can be sent at once."
},
"street1": {
"maxLength": 100,
"minLength": 0,
"type": "string",
"description": "This is the main street address. I.E. 1234 Main St.",
"nullable": true
},
"street2": {
"maxLength": 100,
"minLength": 0,
"type": "string",
"description": "This is the secondary part of the address reserved for things such as identifying suite or apartment numbers.",
"nullable": true
},
"municipality": {
"maxLength": 100,
"minLength": 0,
"type": "string",
"description": "The city/municipality of the address.",
"nullable": true
},
"region": {
"maxLength": 100,
"minLength": 0,
"type": "string",
"description": "The state/region of the address.",
"nullable": true
},
"postalCode": {
"maxLength": 100,
"minLength": 0,
"type": "string",
"description": "The postal code of the address.",
"nullable": true
}
},
"additionalProperties": false,
"description": "The address that should be standardized."
},
"TwApi.Services.System.API.Models.CalculateMarkupsUsingMultiplierCodeRequest": {
"type": "object",
"properties": {
"multiplierCodeId": {
"type": "integer",
"description": "The Id of the multiplier code to use. A list of valid multiplier codes can be found at the datalists/multiplierCodes\r\nendpoint or at customers/{customerId}/multiplierCodes if calculating for an order or assignment.",
"format": "int32"
},
"changedValue": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.Utilities.CalculateMarkupsCommand.ChangedValue"
},
"overtimeFactor": {
"type": "number",
"description": "The number the base rate should be multiplied by to calculate the overtime rate.",
"format": "double"
},
"doubletimeFactor": {
"type": "number",
"description": "The number the base rate should be multiplied by to calculate the doubletime rate.",
"format": "double"
},
"payRate": {
"type": "number",
"description": "The current base pay rate",
"format": "double"
},
"overtimePayRate": {
"type": "number",
"description": "The current overtime pay rate",
"format": "double"
},
"doubletimePayRate": {
"type": "number",
"description": "The current doubletime pay rate",
"format": "double"
},
"billRate": {
"type": "number",
"description": "The current base bill rate",
"format": "double"
},
"overtimeBillRate": {
"type": "number",
"description": "The current overtime bill rate",
"format": "double"
},
"doubletimeBillRate": {
"type": "number",
"description": "The current doubletime bill rate",
"format": "double"
}
},
"additionalProperties": false,
"description": "A request to calculate bill and pay markups based on existing rates and the specified multiplier code."
},
"TwApi.Services.System.API.Models.ClonePowerBiReportRequest": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"maxLength": 255,
"minLength": 1,
"type": "string",
"description": "The name of the new report"
},
"datasetId": {
"type": "string",
"description": "Optional. Parameter for specifying the target associated dataset ID. If not provided, the new report will be associated with the same dataset as the source report.",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to clone an existing report for power bi."
},
"TwApi.Services.System.API.Models.CreateEmailAccountRequest": {
"required": [
"description",
"name",
"senderEmail"
],
"type": "object",
"properties": {
"name": {
"maxLength": 255,
"minLength": 1,
"type": "string",
"description": "The Name that the Email Account sends from."
},
"description": {
"maxLength": 255,
"minLength": 1,
"type": "string",
"description": "A Description of the Email Account."
},
"senderEmail": {
"maxLength": 255,
"minLength": 1,
"type": "string",
"description": "The Email Address the Email Account sends from."
},
"senderName": {
"maxLength": 255,
"type": "string",
"description": "The Sender Name the Email Account sends from.",
"nullable": true
},
"replyTo": {
"maxLength": 100,
"type": "string",
"description": "The Email Address that recipients reply to.",
"nullable": true
},
"defaultSignatureId": {
"type": "integer",
"description": "The Id of the Default Signature for the Email Account.",
"format": "int32",
"nullable": true
},
"defaultSignatureGuid": {
"type": "string",
"description": "The Guid of the Default Signature for the Email Account.",
"format": "uuid",
"nullable": true
},
"serviceTypeId": {
"$ref": "#/components/schemas/TwApi.Common.Enums.EmailServiceType"
},
"smtpSettings": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Email.SmtpSettingsRequest"
}
},
"additionalProperties": false,
"description": "A Request containing information about an Email Account."
},
"TwApi.Services.System.API.Models.CreatePowerBiReportRequest": {
"required": [
"datasetId",
"name"
],
"type": "object",
"properties": {
"name": {
"maxLength": 255,
"minLength": 1,
"type": "string",
"description": "The name of the new report"
},
"datasetId": {
"type": "string",
"description": "Parameter for specifying the target associated dataset ID.",
"format": "uuid"
}
},
"additionalProperties": false,
"description": "A request to create a Power BI Report."
},
"TwApi.Services.System.API.Models.GeneratePowerBiReportEmbeddedTokenRequest": {
"required": [
"datasetId"
],
"type": "object",
"properties": {
"datasetId": {
"type": "string",
"description": "The dataset that will be used in the report",
"format": "uuid"
}
},
"additionalProperties": false,
"description": "A request to generate an embedded token for power bi report creation."
},
"TwApi.Services.System.API.Models.RedeemOauthCodeForExistingEmailAccountRequest": {
"required": [
"code",
"redirectUri"
],
"type": "object",
"properties": {
"code": {
"minLength": 1,
"type": "string",
"description": "The authorization code to redeem for a token."
},
"redirectUri": {
"minLength": 1,
"type": "string",
"description": "The redirect URI that was used to obtain the Code value."
}
},
"additionalProperties": false,
"description": "Request message for redeeming an authorization code for an access_token to a protected resource, such as Office 365."
},
"TwApi.Services.System.API.Models.RedeemOauthCodeForNewEmailAccountRequest": {
"required": [
"code",
"redirectUri",
"serviceTypeId"
],
"type": "object",
"properties": {
"serviceTypeId": {
"$ref": "#/components/schemas/TwApi.Common.Enums.EmailServiceType"
},
"code": {
"minLength": 1,
"type": "string",
"description": "The authorization code to redeem for a token."
},
"redirectUri": {
"minLength": 1,
"type": "string",
"description": "The redirect URI that was used to obtain the Code value."
}
},
"additionalProperties": false,
"description": "Request message for redeeming an authorization code for an access_token to a protected resource, such as Office 365."
},
"TwApi.Services.System.API.Models.RunDataExportRequest": {
"type": "object",
"properties": {
"parameters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Models.DataExportParameterValue"
},
"description": "A list of parameters to be passed to the export. A list of parameters for a specific export can be found at the\r\nData Export Parameters endpoint.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to run a data export."
},
"TwApi.Services.System.API.Models.StandardizeAddressesRequest": {
"required": [
"addressesCountryCode",
"addressesToStandardize"
],
"type": "object",
"properties": {
"addressesCountryCode": {
"type": "integer",
"description": "The Country Code of the country the addresses are in. A list of country codes can be found at the datalists/countries\r\nendpoint.",
"format": "int32"
},
"addressesToStandardize": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.API.Models.AddressToStandardize"
},
"description": "The list of addresses to standardize."
},
"standardizationService": {
"type": "integer",
"description": "Optional: The address standardization service to use. If not provided, the system default will be used.",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to standardize a list of addresses."
},
"TwApi.Services.System.API.Models.UpdateEmailAccountRequest": {
"required": [
"description",
"name",
"senderEmail"
],
"type": "object",
"properties": {
"smtpSettings": {
"$ref": "#/components/schemas/TwApi.Common.Shared.Models.Email.UpdateSmtpSettingsRequest"
},
"name": {
"maxLength": 255,
"minLength": 1,
"type": "string",
"description": "The Name that the Email Account sends from."
},
"description": {
"maxLength": 255,
"minLength": 1,
"type": "string",
"description": "A Description of the Email Account."
},
"senderEmail": {
"maxLength": 255,
"minLength": 1,
"type": "string",
"description": "The Email Address the Email Account sends from."
},
"senderName": {
"maxLength": 255,
"type": "string",
"description": "The Sender Name the Email Account sends from.",
"nullable": true
},
"replyTo": {
"maxLength": 100,
"type": "string",
"description": "The Email Address that recipients reply to.",
"nullable": true
},
"defaultSignatureId": {
"type": "integer",
"description": "The Id of the Default Signature for the Email Account.",
"format": "int32",
"nullable": true
},
"defaultSignatureGuid": {
"type": "string",
"description": "The Guid of the Default Signature for the Email Account.",
"format": "uuid",
"nullable": true
},
"serviceTypeId": {
"$ref": "#/components/schemas/TwApi.Common.Enums.EmailServiceType"
}
},
"additionalProperties": false,
"description": "A Request containing information for Updating an Email Account."
},
"TwApi.Services.System.API.Models.UpsertEmailSignatureRequest": {
"required": [
"name",
"signature"
],
"type": "object",
"properties": {
"name": {
"maxLength": 255,
"minLength": 1,
"type": "string",
"description": "The name of the email signature."
},
"signature": {
"minLength": 1,
"type": "string",
"description": "The email signature."
}
},
"additionalProperties": false,
"description": "An object containing the email signature."
},
"TwApi.Services.System.API.Models.WebUsers.WebUserResetPasswordRequest": {
"required": [
"fromSenderName",
"username"
],
"type": "object",
"properties": {
"username": {
"maxLength": 254,
"minLength": 1,
"type": "string",
"description": "The username of the web user requesting a password reset."
},
"fromSenderName": {
"minLength": 1,
"type": "string",
"description": "The sender name to use when sending the email.\r\nThis would typically be the branded name of the app."
},
"logoImageAsBase64": {
"type": "string",
"description": "Optional branding image to include in the email.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Request model for initiating a password reset for a web user"
},
"TwApi.Services.System.API.Models.WebUsers.WebUserResetPasswordValidateCodeRequest": {
"required": [
"code",
"username"
],
"type": "object",
"properties": {
"username": {
"maxLength": 254,
"minLength": 1,
"type": "string",
"description": "The username of the web user requesting a password reset."
},
"code": {
"maxLength": 6,
"minLength": 6,
"type": "string",
"description": "The code that was sent to the user in a password reset request.\r\nCodes are exactly 6 digits long."
}
},
"additionalProperties": false,
"description": "Request model for validating a password reset code for a web user"
},
"TwApi.Services.System.Service.Commands.BusinessIntelligence.Cloud.CloudWorkspaceCloneReport.Result": {
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"format": "uuid"
},
"token": {
"type": "string",
"nullable": true
},
"tokenId": {
"type": "string",
"nullable": true
},
"expiration": {
"type": "string",
"format": "date-time"
},
"id": {
"type": "string",
"format": "uuid"
},
"reportType": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"webUrl": {
"type": "string",
"nullable": true
},
"embedUrl": {
"type": "string",
"nullable": true
},
"isFromPbix": {
"type": "boolean"
},
"isOwnedByMe": {
"type": "boolean"
},
"datasetId": {
"type": "string",
"format": "uuid"
},
"datasetWorkspaceId": {
"type": "string",
"format": "uuid"
},
"users": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"subscriptions": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.BusinessIntelligence.Cloud.CloudWorkspaceDataset.Result": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"webUrl": {
"type": "string",
"nullable": true
},
"contentProviderType": {
"type": "string",
"nullable": true
},
"createReportEmbedURL": {
"type": "string",
"nullable": true
},
"createdDate": {
"type": "string",
"nullable": true
},
"encryption": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.PowerBiCloud.Service.Models.Encryption"
},
"isEffectiveIdentityRequired": {
"type": "boolean"
},
"isEffectiveIdentityRolesRequired": {
"type": "boolean"
},
"isOnPremGatewayRequired": {
"type": "boolean"
},
"isRefreshable": {
"type": "boolean"
},
"qnaEmbedURL": {
"type": "string",
"nullable": true
},
"addRowsAPIEnabled": {
"type": "boolean"
},
"configuredBy": {
"type": "string",
"nullable": true
},
"targetStorageMode": {
"type": "string",
"nullable": true
},
"upstreamDataflows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.PowerBiCloud.Service.Models.DependentDataflow"
},
"nullable": true
},
"users": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.PowerBiCloud.Service.Models.DatasetUser"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.BusinessIntelligence.Cloud.CloudWorkspaceGenerateEmbeddedToken.Result": {
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"format": "uuid"
},
"datasetId": {
"type": "string",
"format": "uuid"
},
"embedUrl": {
"type": "string",
"nullable": true
},
"token": {
"type": "string",
"nullable": true
},
"tokenId": {
"type": "string",
"nullable": true
},
"expiration": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.BusinessIntelligence.Cloud.CloudWorkspaceReport.Result": {
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"format": "uuid"
},
"token": {
"type": "string",
"nullable": true
},
"tokenId": {
"type": "string",
"nullable": true
},
"expiration": {
"type": "string",
"format": "date-time"
},
"canEdit": {
"type": "boolean"
},
"id": {
"type": "string",
"format": "uuid"
},
"reportType": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"webUrl": {
"type": "string",
"nullable": true
},
"embedUrl": {
"type": "string",
"nullable": true
},
"isFromPbix": {
"type": "boolean"
},
"isOwnedByMe": {
"type": "boolean"
},
"datasetId": {
"type": "string",
"format": "uuid"
},
"datasetWorkspaceId": {
"type": "string",
"format": "uuid"
},
"users": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"subscriptions": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.CustomContent.CardDetails.Result": {
"type": "object",
"properties": {
"hierId": {
"type": "integer",
"format": "int32"
},
"originTypeId": {
"type": "integer",
"format": "int32"
},
"hier": {
"type": "string",
"nullable": true
},
"cardId": {
"type": "integer",
"format": "int32"
},
"cardType": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"size": {
"$ref": "#/components/schemas/TwApi.Common.Enums.CardSize"
},
"isPublished": {
"type": "boolean"
},
"props": {
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.CustomContent.CardsByHier.Result": {
"type": "object",
"properties": {
"cardId": {
"type": "integer",
"format": "int32"
},
"cardType": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"hierId": {
"type": "integer",
"format": "int32"
},
"originTypeId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.CustomContent.CardsInPage.Result": {
"type": "object",
"properties": {
"pageId": {
"type": "integer",
"format": "int32"
},
"cardId": {
"type": "integer",
"format": "int32"
},
"shouldFillPage": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.CustomContent.ContentRouteList.Result": {
"type": "object",
"properties": {
"pageId": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"originTypeId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.CustomContent.CreateCard.Result": {
"type": "object",
"properties": {
"cardId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.CustomContent.CreatePage.Result": {
"type": "object",
"properties": {
"pageId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.CustomContent.EligibleCardsForPage.Result": {
"type": "object",
"properties": {
"cardId": {
"type": "integer",
"format": "int32"
},
"cardType": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"hierId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.CustomContent.PageDetails.Card": {
"type": "object",
"properties": {
"cardId": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"size": {
"$ref": "#/components/schemas/TwApi.Common.Enums.CardSize"
},
"shouldFillPage": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.CustomContent.PageDetails.Result": {
"type": "object",
"properties": {
"pageId": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"hierId": {
"type": "integer",
"format": "int32"
},
"hier": {
"type": "string",
"nullable": true
},
"isPublished": {
"type": "boolean"
},
"originTypeId": {
"type": "integer",
"format": "int32"
},
"cards": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.CustomContent.PageDetails.Card"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.CustomContent.PageList.Result": {
"type": "object",
"properties": {
"pageId": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"hierId": {
"type": "integer",
"format": "int32"
},
"hierName": {
"type": "string",
"nullable": true
},
"originTypeId": {
"type": "integer",
"format": "int32"
},
"isPublished": {
"type": "boolean"
},
"createdBySrIdent": {
"type": "integer",
"format": "int32"
},
"canEdit": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.CustomContent.PagesWithCardsByHier.CardBasicInfo": {
"type": "object",
"properties": {
"cardId": {
"type": "string",
"nullable": true
},
"cardType": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.CustomContent.PagesWithCardsByHier.PageBasicInfo": {
"type": "object",
"properties": {
"pageId": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"originTypeId": {
"type": "integer",
"format": "int32"
},
"cards": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.CustomContent.PagesWithCardsByHier.CardBasicInfo"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.CustomData.CreatePropertyPermissionCommand.Result": {
"type": "object",
"properties": {
"propertyPermissionId": {
"type": "integer",
"format": "int64"
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.CustomData.PropertyPermissionsQuery.Result": {
"type": "object",
"properties": {
"propertyPermissionId": {
"type": "integer",
"format": "int64"
},
"propertyDefinitionId": {
"type": "string",
"format": "uuid"
},
"propertyName": {
"type": "string",
"nullable": true
},
"denyWrite": {
"type": "boolean"
},
"denyRead": {
"type": "boolean"
},
"securityGroupId": {
"type": "string",
"format": "uuid"
},
"securityGroupName": {
"type": "string",
"nullable": true
},
"canEdit": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.DataExport.DataExportCategoryList.Result": {
"type": "object",
"properties": {
"exportCategoryId": {
"type": "string",
"format": "uuid"
},
"exportCategory": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.DataExport.DataExportList.Result": {
"type": "object",
"properties": {
"exportId": {
"type": "string",
"format": "uuid"
},
"export": {
"type": "string",
"nullable": true
},
"exportCategoryId": {
"type": "string",
"format": "uuid"
},
"exportCategory": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.DataExport.DataExportParameterList.ParameterDatalistKeyValue": {
"type": "object",
"properties": {
"value": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.DataExport.DataExportParameterList.Result": {
"type": "object",
"properties": {
"exportParameterId": {
"type": "string",
"format": "uuid"
},
"exportParameter": {
"type": "string",
"nullable": true
},
"dataType": {
"type": "string",
"nullable": true
},
"isRequired": {
"type": "boolean"
},
"sortOrder": {
"type": "integer",
"format": "int32"
},
"usesDatalist": {
"type": "boolean"
},
"parameterDatalist": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.DataExport.DataExportParameterList.ParameterDatalistKeyValue"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.EmailAccounts.CreateEmailAccount.Result": {
"type": "object",
"properties": {
"accountId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.EmailAccounts.CreateEmailSignature.Result": {
"type": "object",
"properties": {
"signatureId": {
"type": "integer",
"format": "int32"
},
"signatureGuid": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.EmailAccounts.EmailAccountsList.Result": {
"type": "object",
"properties": {
"accountId": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"senderEmail": {
"type": "string",
"nullable": true
},
"senderName": {
"type": "string",
"nullable": true
},
"replyTo": {
"type": "string",
"nullable": true
},
"serviceTypeId": {
"type": "integer",
"format": "int32"
},
"serviceType": {
"type": "string",
"nullable": true
},
"teams": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.EmailAccounts.EmailSignatureDetails.Result": {
"type": "object",
"properties": {
"signatureId": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"signature": {
"type": "string",
"nullable": true
},
"createdByServiceRep": {
"type": "string",
"nullable": true
},
"createdByServiceRepId": {
"type": "integer",
"format": "int32"
},
"dateCreated": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.EmailAccounts.EmailSignaturesList.Result": {
"type": "object",
"properties": {
"signatureId": {
"type": "integer",
"format": "int32"
},
"signatureGuid": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"signature": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.EmailAccounts.RedeemOAuthCodeForNewEmailAccount.Result": {
"type": "object",
"properties": {
"emailAccountId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.EmailAccounts.TestEmailAccount.Result": {
"type": "object",
"properties": {
"errorType": {
"type": "integer",
"format": "int32"
},
"smtpLog": {
"type": "string",
"nullable": true
},
"isError": {
"type": "boolean"
},
"message": {
"type": "string",
"nullable": true
},
"diagnosticInfo": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Models.ExternalServiceDiagnostic"
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.ExternalServices.ExternalServicesMetadata.Result": {
"type": "object",
"properties": {
"services": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.ExternalServices.ExternalServicesMetadata.ServiceExistenceMetadata"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.ExternalServices.ExternalServicesMetadata.ServiceExistenceMetadata": {
"type": "object",
"properties": {
"externalServiceId": {
"type": "integer",
"format": "int64"
},
"externalService": {
"type": "string",
"nullable": true
},
"isEnabled": {
"type": "boolean"
},
"areCredentialsSetUp": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.GetServiceRepTokenQuery.Response": {
"type": "object",
"properties": {
"accountSid": {
"type": "string",
"nullable": true
},
"tenantId": {
"type": "integer",
"format": "int32"
},
"isActive": {
"type": "boolean"
},
"allowedScopes": {
"type": "string",
"nullable": true
},
"srIdent": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string",
"nullable": true
},
"expiresUtc": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.Hotlists.CreateHotlist.Result": {
"type": "object",
"properties": {
"hotlistId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.Hotlists.GetContactHotlistMembers.Result": {
"type": "object",
"properties": {
"hotlistId": {
"type": "string",
"format": "uuid"
},
"hotlistMemberId": {
"type": "string",
"format": "uuid"
},
"contactId": {
"type": "integer",
"format": "int64"
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"note": {
"type": "string",
"nullable": true
},
"customerId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"customerName": {
"type": "string",
"nullable": true
},
"departmentName": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"position": {
"type": "integer",
"format": "int32"
},
"officePhone": {
"type": "string",
"nullable": true
},
"officePhoneCountryCallingCode": {
"type": "integer",
"format": "int32",
"nullable": true
},
"emailAddress": {
"type": "string",
"nullable": true
},
"lastMessageDate": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.Hotlists.GetCustomerHotlistMembers.Result": {
"type": "object",
"properties": {
"hotlistId": {
"type": "string",
"format": "uuid"
},
"hotlistMemberId": {
"type": "string",
"format": "uuid"
},
"customerId": {
"type": "integer",
"format": "int64"
},
"customerName": {
"type": "string",
"nullable": true
},
"departmentName": {
"type": "string",
"nullable": true
},
"position": {
"type": "integer",
"format": "int32"
},
"note": {
"type": "string",
"nullable": true
},
"officePhone": {
"type": "string",
"nullable": true
},
"officePhoneCountryCallingCode": {
"type": "integer",
"format": "int32",
"nullable": true
},
"lastMessageDate": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.Hotlists.GetEmployeeHotlistMembers.Result": {
"type": "object",
"properties": {
"hotlistId": {
"type": "string",
"format": "uuid"
},
"hotlistMemberId": {
"type": "string",
"format": "uuid"
},
"position": {
"type": "integer",
"format": "int32"
},
"employeeId": {
"type": "integer",
"format": "int64"
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"lastDateAvailable": {
"type": "string",
"format": "date-time",
"nullable": true
},
"isAssigned": {
"type": "boolean"
},
"employeePrimaryPhoneNumber": {
"type": "string",
"nullable": true
},
"employeePrimaryEmailAddress": {
"type": "string",
"nullable": true
},
"employeePhoneNumber": {
"type": "string",
"nullable": true
},
"employeeEmailAddress": {
"type": "string",
"nullable": true
},
"hotlistStepId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"hotlistStep": {
"type": "string",
"nullable": true
},
"note": {
"type": "string",
"nullable": true
},
"lastMessageDate": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.Hotlists.GetHotlist.HotlistSharedServiceRep": {
"type": "object",
"properties": {
"serviceRepId": {
"type": "integer",
"format": "int32"
},
"fullName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.Hotlists.GetHotlist.HotlistSharedTeam": {
"type": "object",
"properties": {
"teamId": {
"type": "integer",
"format": "int32"
},
"teamName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.Hotlists.GetHotlist.Result": {
"type": "object",
"properties": {
"hotlistId": {
"type": "string",
"format": "uuid"
},
"memberOriginTypeId": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"ownerSrIdent": {
"type": "integer",
"format": "int32"
},
"isPublic": {
"type": "boolean"
},
"hierId": {
"type": "integer",
"format": "int32"
},
"lastUpdatedUTC": {
"type": "string",
"format": "date-time"
},
"dateCreatedUTC": {
"type": "string",
"format": "date-time"
},
"canManage": {
"type": "boolean"
},
"canEdit": {
"type": "boolean"
},
"sharedUsersCanEdit": {
"type": "boolean"
},
"integerHotlistId": {
"type": "integer",
"format": "int64"
},
"sharedWithServiceReps": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.Hotlists.GetHotlist.HotlistSharedServiceRep"
},
"nullable": true
},
"sharedWithServiceRepTeams": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.Hotlists.GetHotlist.HotlistSharedTeam"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.Hotlists.GetHotlistMembership.Result": {
"type": "object",
"properties": {
"hotlistId": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"ownerServiceRep": {
"type": "string",
"nullable": true
},
"ownerServiceRepId": {
"type": "integer",
"format": "int64"
},
"hotlistType": {
"$ref": "#/components/schemas/TwApi.Common.Enums.HotlistType"
},
"canManage": {
"type": "boolean"
},
"canEdit": {
"type": "boolean"
},
"isPublic": {
"type": "boolean"
},
"isSharedWithYou": {
"type": "boolean"
},
"isSharedWithYourTeam": {
"type": "boolean"
},
"isShared": {
"type": "boolean"
},
"integerHotlistId": {
"type": "integer",
"format": "int64",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.Hotlists.GetHotlists.Result": {
"type": "object",
"properties": {
"hotlistId": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"ownerServiceRep": {
"type": "string",
"nullable": true
},
"ownerServiceRepId": {
"type": "integer",
"format": "int64"
},
"hotlistType": {
"$ref": "#/components/schemas/TwApi.Common.Enums.HotlistType"
},
"canManage": {
"type": "boolean"
},
"canEdit": {
"type": "boolean"
},
"isPublic": {
"type": "boolean"
},
"isSharedWithYou": {
"type": "boolean"
},
"isSharedWithYourTeam": {
"type": "boolean"
},
"isShared": {
"type": "boolean"
},
"integerHotlistId": {
"type": "integer",
"format": "int64",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.Hotlists.GetHotlistsByOriginType.Result": {
"type": "object",
"properties": {
"hotlistId": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"canEdit": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.Hotlists.HotlistAvailableServiceReps.Result": {
"type": "object",
"properties": {
"serviceRepId": {
"type": "integer",
"format": "int32"
},
"username": {
"type": "string",
"nullable": true
},
"fullName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.Hotlists.HotlistAvailableTeams.Result": {
"type": "object",
"properties": {
"teamId": {
"type": "integer",
"format": "int32"
},
"teamName": {
"type": "string",
"nullable": true
},
"teamOwnerServiceRepId": {
"type": "integer",
"format": "int32"
},
"teamOwner": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.Hotlists.ValidateHotlistMembers.Result": {
"type": "object",
"properties": {
"membersToAdd": {
"type": "integer",
"format": "int32"
},
"membersAlreadyIncluded": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.MessageAggregateQuery.Result": {
"type": "object",
"properties": {
"originId": {
"type": "integer",
"format": "int64"
},
"originTypeId": {
"type": "integer",
"format": "int32"
},
"originDescription": {
"type": "string",
"nullable": true
},
"totalMessages": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.MessageStreamQuery.Result": {
"type": "object",
"properties": {
"messageId": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string",
"nullable": true
},
"messageActionId": {
"type": "integer",
"format": "int32"
},
"messageAction": {
"type": "string",
"nullable": true
},
"messageActionDescription": {
"type": "string",
"nullable": true
},
"messageActionTypeId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"messageActionType": {
"type": "string",
"nullable": true
},
"messageActionDisplayColor": {
"type": "string",
"nullable": true
},
"authorSrIdent": {
"type": "integer",
"format": "int32"
},
"author": {
"type": "string",
"nullable": true
},
"messageDate": {
"type": "string",
"format": "date-time"
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageLink"
},
"nullable": true
},
"linkedDocumentsCount": {
"type": "integer",
"format": "int32",
"nullable": true
},
"primaryOriginTypeId": {
"$ref": "#/components/schemas/TwApi.Common.Enums.OriginType"
},
"primaryOriginId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"messageLinkedDocuments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.Messages.MessageLinkedDocument"
},
"nullable": true
},
"viaIntegrationName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.ProductInstances.ProductInstanceConfigurationsQuery.Result": {
"type": "object",
"properties": {
"productConfigurationTypeId": {
"type": "string",
"nullable": true
},
"configuration": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"category": {
"type": "string",
"nullable": true
},
"valueType": {
"type": "string",
"nullable": true
},
"value": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.SecurityGroups.CreateSecurityGroupCommand.Result": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.SecurityGroups.CreateSecurityGroupPermissionCommand.Result": {
"type": "object",
"properties": {
"permissionId": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.SecurityGroups.GetSecurityGroupBeyondAdvancedPermissions.Result": {
"type": "object",
"properties": {
"securityGroupId": {
"type": "string",
"format": "uuid"
},
"cards": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Models.AdvancedPermissionsCard"
},
"nullable": true
},
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Models.AdvancedPermissionsField"
},
"nullable": true
},
"forms": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Models.AdvancedPermissionsForm"
},
"nullable": true
},
"pages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Models.AdvancedPermissionsPage"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupCustomerStatusListQuery.Result": {
"type": "object",
"properties": {
"customerStatusId": {
"type": "string",
"nullable": true
},
"customerStatus": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupDataExportAvailableListQuery.Result": {
"type": "object",
"properties": {
"exportId": {
"type": "string",
"format": "uuid"
},
"export": {
"type": "string",
"nullable": true
},
"exportCategoryId": {
"type": "string",
"format": "uuid"
},
"exportCategory": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupDataExportListQuery.Result": {
"type": "object",
"properties": {
"exportId": {
"type": "string",
"format": "uuid"
},
"export": {
"type": "string",
"nullable": true
},
"exportCategoryId": {
"type": "string",
"format": "uuid"
},
"exportCategory": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupDocumentTypeListQuery.Result": {
"type": "object",
"properties": {
"documentTypeId": {
"type": "integer",
"format": "int32"
},
"documentType": {
"type": "string",
"nullable": true
},
"canRead": {
"type": "boolean"
},
"canWrite": {
"type": "boolean"
},
"canDelete": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupKpiReport.Result": {
"type": "object",
"properties": {
"reportId": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupListQuery.Result": {
"type": "object",
"properties": {
"securityGroupId": {
"type": "string",
"format": "uuid"
},
"securityGroupTypeId": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"dateCreated": {
"type": "string",
"format": "date-time"
},
"createdBySrident": {
"type": "integer",
"format": "int32"
},
"createdBy": {
"type": "string",
"nullable": true
},
"hierId": {
"type": "integer",
"format": "int32"
},
"isSystemDefault": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupMessageActionTypeListQuery.Result": {
"type": "object",
"properties": {
"messageActionTypeId": {
"type": "string",
"format": "uuid"
},
"messageActionType": {
"type": "string",
"nullable": true
},
"canRead": {
"type": "boolean"
},
"canWrite": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupPermissionQuery.Result": {
"type": "object",
"properties": {
"permissionId": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"tags": {
"type": "string",
"nullable": true
},
"requirePermissionAdmin": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupPermissionsListQuery.Result": {
"type": "object",
"properties": {
"permissionId": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"tags": {
"type": "string",
"nullable": true
},
"requirePermissionAdmin": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupQuery.Result": {
"type": "object",
"properties": {
"securityGroupId": {
"type": "string",
"format": "uuid"
},
"securityGroupTypeId": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"dateCreated": {
"type": "string",
"format": "date-time"
},
"createdBySrident": {
"type": "integer",
"format": "int32"
},
"createdBy": {
"type": "string",
"nullable": true
},
"hierId": {
"type": "integer",
"format": "int32"
},
"isSystemDefault": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupReportGroupQuery.Result": {
"type": "object",
"properties": {
"reportGroupId": {
"type": "string",
"format": "uuid"
},
"reportGroup": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupReportQuery.Result": {
"type": "object",
"properties": {
"reportId": {
"type": "string",
"format": "uuid"
},
"report": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupRolesListQuery.Result": {
"type": "object",
"properties": {
"twRoleId": {
"type": "string",
"format": "uuid"
},
"twRoleName": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"isSystemDefault": {
"type": "boolean"
},
"oAuthClient": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.SecurityGroups.SecurityGroupUsersListQuery.Result": {
"type": "object",
"properties": {
"srIdent": {
"type": "integer",
"format": "int32"
},
"serviceRep": {
"type": "string",
"nullable": true
},
"serviceRepFullName": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"isTWEmployee": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.ServiceRepTeams.ServiceRepTeamSavedSearchesQuery.Result": {
"type": "object",
"properties": {
"savedSearchId": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"originTypeId": {
"type": "integer",
"format": "int32"
},
"originType": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.Users.CreateUserBookmarkCommand.Result": {
"type": "object",
"properties": {
"bookmarkId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.Users.GetCurrentServiceRepDetails.Result": {
"type": "object",
"properties": {
"srIdent": {
"type": "integer",
"format": "int32"
},
"serviceRepGUID": {
"type": "string",
"format": "uuid",
"nullable": true
},
"repFullName": {
"type": "string",
"nullable": true
},
"chatName": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"hierarchyId": {
"type": "integer",
"format": "int32"
},
"hierarchyGuid": {
"type": "string",
"format": "uuid"
},
"hierarchyName": {
"type": "string",
"nullable": true
},
"hierarchyTypeId": {
"type": "integer",
"format": "int32"
},
"hierarchyType": {
"type": "string",
"nullable": true
},
"canExecutePayrollAtCurrentHierarchy": {
"type": "boolean"
},
"canExecuteInvoicingAtCurrentHierarchy": {
"type": "boolean"
},
"einc": {
"type": "integer",
"format": "int32"
},
"companyFullName": {
"type": "string",
"nullable": true
},
"branchId": {
"type": "integer",
"format": "int32"
},
"branchFullName": {
"type": "string",
"nullable": true
},
"branchCountryCode": {
"type": "integer",
"format": "int32"
},
"isPermissionAdmin": {
"type": "boolean"
},
"ianaTimeZone": {
"type": "string",
"nullable": true
},
"dateFormatId": {
"type": "integer",
"format": "int32"
},
"microsoftDateFormat": {
"type": "string",
"nullable": true
},
"microsoftLongDateFormat": {
"type": "string",
"nullable": true
},
"momentDateFormat": {
"type": "string",
"nullable": true
},
"momentLongDateFormat": {
"type": "string",
"nullable": true
},
"timeFormatId": {
"type": "integer",
"format": "int32"
},
"microsoftTimeFormat": {
"type": "string",
"nullable": true
},
"momentTimeFormat": {
"type": "string",
"nullable": true
},
"localeId": {
"type": "string",
"nullable": true
},
"locale": {
"type": "string",
"nullable": true
},
"twUniqueId": {
"type": "string",
"nullable": true
},
"isTempWorksEmployee": {
"type": "boolean"
},
"isOrganizationAdministrator": {
"type": "boolean"
},
"isSignedInWithSingleSignOn": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.Users.ServiceRepQuery.Result": {
"type": "object",
"properties": {
"srIdent": {
"type": "integer",
"format": "int32"
},
"repFullName": {
"type": "string",
"nullable": true
},
"chatName": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"companyFullName": {
"type": "string",
"nullable": true
},
"branchId": {
"type": "integer",
"format": "int32"
},
"branchFullName": {
"type": "string",
"nullable": true
},
"branchCountryCode": {
"type": "integer",
"format": "int32"
},
"isPermissionAdmin": {
"type": "boolean"
},
"ianaTimeZone": {
"type": "string",
"nullable": true
},
"dateFormatId": {
"type": "integer",
"format": "int32"
},
"microsoftDateFormat": {
"type": "string",
"nullable": true
},
"microsoftLongDateFormat": {
"type": "string",
"nullable": true
},
"momentDateFormat": {
"type": "string",
"nullable": true
},
"momentLongDateFormat": {
"type": "string",
"nullable": true
},
"timeFormatId": {
"type": "integer",
"format": "int32"
},
"microsoftTimeFormat": {
"type": "string",
"nullable": true
},
"momentTimeFormat": {
"type": "string",
"nullable": true
},
"localeId": {
"type": "string",
"nullable": true
},
"locale": {
"type": "string",
"nullable": true
},
"twUniqueId": {
"type": "string",
"nullable": true
},
"isTempWorksEmployee": {
"type": "boolean"
},
"isActive": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.Users.UserBookmarksQuery.Result": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"originType": {
"$ref": "#/components/schemas/TwApi.Common.Enums.OriginType"
},
"originId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"sortOrder": {
"type": "integer",
"format": "int32"
},
"entity": {
"nullable": true
},
"route": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.Users.UserLocalizationSettingsQuery.Result": {
"type": "object",
"properties": {
"ianaTimeZone": {
"type": "string",
"nullable": true
},
"dateFormatId": {
"type": "integer",
"format": "int32"
},
"microsoftDateFormat": {
"type": "string",
"nullable": true
},
"microsoftLongDateFormat": {
"type": "string",
"nullable": true
},
"momentDateFormat": {
"type": "string",
"nullable": true
},
"momentLongDateFormat": {
"type": "string",
"nullable": true
},
"timeFormatId": {
"type": "integer",
"format": "int32"
},
"microsoftTimeFormat": {
"type": "string",
"nullable": true
},
"momentTimeFormat": {
"type": "string",
"nullable": true
},
"localeId": {
"type": "string",
"nullable": true
},
"locale": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.Users.UserPermissionsListQuery.Result": {
"type": "object",
"properties": {
"permissionId": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"tags": {
"type": "string",
"nullable": true
},
"requirePermissionAdmin": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.Users.UserSecurityGroupsQuery.Result": {
"type": "object",
"properties": {
"securityGroupId": {
"type": "string",
"format": "uuid"
},
"securityGroupTypeId": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"dateCreated": {
"type": "string",
"format": "date-time"
},
"createdBySrident": {
"type": "integer",
"format": "int32"
},
"createdBy": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.Users.UserSelectableHierTypeQuery.Result": {
"type": "object",
"properties": {
"hierarchyTypeId": {
"type": "integer",
"format": "int32"
},
"hierarchyType": {
"type": "string",
"nullable": true
},
"isMasterTableDataAllowed": {
"type": "boolean"
},
"isPayrollRunAllowed": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.Users.UserSelectableHierarchyQuery.HierNode": {
"type": "object",
"properties": {
"hierId": {
"type": "integer",
"format": "int32"
},
"hierGuid": {
"type": "string",
"format": "uuid"
},
"hierarchy": {
"type": "string",
"nullable": true
},
"hierarchyTypeId": {
"type": "integer",
"format": "int32"
},
"hierarchyType": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"isCurrentlyVisible": {
"type": "boolean"
},
"isBranch": {
"type": "boolean"
},
"branchId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"parentHierId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"children": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.Users.UserSelectableHierarchyQuery.HierNode"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.Users.UserSelectableHierarchyQuery.Result": {
"type": "object",
"properties": {
"root": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Commands.Users.UserSelectableHierarchyQuery.HierNode"
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Commands.WebUsers.WebUserValidateResetPasswordCode.Result": {
"type": "object",
"properties": {
"isValid": {
"type": "boolean"
},
"originId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"originTypeId": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Models.AdvancedPermissionsCard": {
"type": "object",
"properties": {
"cardId": {
"type": "string",
"nullable": true
},
"canAccess": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Models.AdvancedPermissionsField": {
"type": "object",
"properties": {
"fieldId": {
"type": "string",
"nullable": true
},
"denyRead": {
"type": "boolean"
},
"denyWrite": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Models.AdvancedPermissionsForm": {
"type": "object",
"properties": {
"formComponentId": {
"type": "string",
"nullable": true
},
"canAccess": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Models.AdvancedPermissionsPage": {
"type": "object",
"properties": {
"routeId": {
"type": "string",
"nullable": true
},
"canAccess": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Models.Card": {
"type": "object",
"properties": {
"originTypeId": {
"type": "integer",
"format": "int32"
},
"hierId": {
"type": "integer",
"format": "int32"
},
"hierName": {
"type": "string",
"nullable": true
},
"canEdit": {
"type": "boolean"
},
"cardId": {
"type": "integer",
"format": "int32"
},
"cardType": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"size": {
"$ref": "#/components/schemas/TwApi.Common.Enums.CardSize"
},
"isPublished": {
"type": "boolean"
},
"props": {
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Models.CardSummary": {
"type": "object",
"properties": {
"cardId": {
"type": "integer",
"format": "int32"
},
"cardType": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"size": {
"$ref": "#/components/schemas/TwApi.Common.Enums.CardSize"
},
"isPublished": {
"type": "boolean"
},
"props": {
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Models.DataExportParameterValue": {
"type": "object",
"properties": {
"exportParameterId": {
"type": "string",
"format": "uuid"
},
"value": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Models.ExternalServiceDiagnostic": {
"type": "object",
"properties": {
"externalServiceIsValid": {
"type": "boolean",
"readOnly": true
},
"summary": {
"type": "string",
"nullable": true
},
"log": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Services.System.Service.Models.ExternalServiceDiagnosticLogEntry"
},
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"TwApi.Services.System.Service.Models.ExternalServiceDiagnosticLogEntry": {
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date-time"
},
"isError": {
"type": "boolean"
},
"message": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Tasks.Service.Commands.ExistingTagListQuery.Result": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"totalCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Texting.API.Models.AssignmentContactsRequest": {
"type": "object",
"properties": {
"assignmentIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "List of AssignmentIds",
"nullable": true
},
"contactRoleId": {
"type": "integer",
"description": "Contact role of the returned contacts, default is 0 - Supervisor",
"format": "int32"
}
},
"additionalProperties": false,
"description": "A request to get the ContactIds for the specified AssignmentIds"
},
"TwApi.Services.Texting.API.Models.CreateSenseCustomDataFieldMappingRequest": {
"required": [
"propertyDefinitionId",
"senseCustomDataFieldId"
],
"type": "object",
"properties": {
"senseCustomDataFieldId": {
"type": "integer",
"description": "Sense custom data field Id to be mapped.",
"format": "int32"
},
"propertyDefinitionId": {
"type": "string",
"description": "The Property definition Id to be mapped.",
"format": "uuid"
},
"description": {
"maxLength": 250,
"minLength": 0,
"type": "string",
"description": "Description to be associated with the field mapping.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to create sense custom data field mapping."
},
"TwApi.Services.Texting.API.Models.MessageSendRequest": {
"required": [
"externalServiceId",
"recipients"
],
"type": "object",
"properties": {
"recipients": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.Origin"
},
"description": "A list of recipients of the text message."
},
"message": {
"type": "string",
"description": "The text message to be sent.\r\nRequired for all external services except Text-Em-All.\r\nSince Text-em-all is single-sign-on, users will enter their message through their portal, so this will be discarded.",
"nullable": true
},
"externalServiceId": {
"type": "integer",
"description": "The Exteral Service Id of the texting vendor.",
"format": "int64"
}
},
"additionalProperties": false,
"description": "A request to send a text message."
},
"TwApi.Services.Texting.API.Models.OneToOneConversationDataRequest": {
"type": "object",
"properties": {
"originId": {
"type": "integer",
"description": "OriginId of the recipient",
"format": "int64"
},
"originTypeId": {
"type": "integer",
"description": "OriginTypeId of recipient",
"format": "int32"
},
"externalServiceId": {
"type": "integer",
"description": "Id of the external service to use.",
"format": "int64",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to get texting recipient data"
},
"TwApi.Services.Texting.API.Models.RecipientDataRequest": {
"type": "object",
"properties": {
"excludeInvalidRecipients": {
"type": "boolean",
"description": "This will exclude invalid recipients from the output"
},
"excludeValidRecipients": {
"type": "boolean",
"description": "This will exclude valid recipients from the output"
},
"origins": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Models.OriginRequestModel"
},
"description": "List of OriginIds and OriginTypeIds",
"nullable": true
},
"externalServiceId": {
"type": "integer",
"description": "Id of the external service to use.",
"format": "int64",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to get texting recipient data"
},
"TwApi.Services.Texting.API.Models.UpdateSenseCustomDataFieldMappingRequest": {
"required": [
"propertyDefinitionId",
"senseCustomDataFieldId"
],
"type": "object",
"properties": {
"senseCustomDataFieldId": {
"type": "integer",
"description": "Sense custom data field Id to be mapped.",
"format": "int32"
},
"propertyDefinitionId": {
"type": "string",
"description": "The Property definition Id to be mapped.",
"format": "uuid"
},
"description": {
"maxLength": 250,
"minLength": 0,
"type": "string",
"description": "Description to be associated with the field mapping.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to create sense custom data field mapping."
},
"TwApi.Services.Texting.Service.Commands.GetConversationPortalUrl.Result": {
"type": "object",
"properties": {
"externalServicePortalUrl": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Texting.Service.Commands.OneToOneConversationData.Result": {
"type": "object",
"properties": {
"originId": {
"type": "integer",
"format": "int64"
},
"originTypeId": {
"type": "integer",
"format": "int32"
},
"contactMethodId": {
"type": "integer",
"format": "int32"
},
"contactMethod": {
"type": "string",
"nullable": true
},
"contactMethodTypeId": {
"type": "integer",
"format": "int32"
},
"countryCallingCode": {
"type": "integer",
"format": "int32",
"nullable": true
},
"phoneNumberType": {
"type": "string",
"nullable": true
},
"isValidContactMethod": {
"type": "boolean"
},
"validationMessage": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Texting.Service.Commands.RecipientData.Result": {
"type": "object",
"properties": {
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"originId": {
"type": "integer",
"format": "int64"
},
"originTypeId": {
"type": "integer",
"format": "int32"
},
"personType": {
"type": "string",
"nullable": true
},
"contactMethodId": {
"type": "integer",
"format": "int32"
},
"phoneNumber": {
"type": "string",
"nullable": true
},
"nationalNumber": {
"type": "string",
"nullable": true
},
"countryCode": {
"type": "string",
"nullable": true
},
"extension": {
"type": "string",
"nullable": true
},
"phoneNumberType": {
"type": "string",
"nullable": true
},
"isValidRecipient": {
"type": "boolean"
},
"validationMessage": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Texting.Service.Commands.SendTextMessageCommand.Result": {
"type": "object",
"properties": {
"batchJobId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"externalServicePortalUrl": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Texting.Service.Commands.Sense.CreateSenseCustomDataFieldMapping.Result": {
"type": "object",
"properties": {
"customDataFieldMappingId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Texting.Service.Commands.Sense.SenseFieldMappingById.Result": {
"type": "object",
"properties": {
"customDataMappingId": {
"type": "integer",
"format": "int32"
},
"senseFieldId": {
"type": "integer",
"format": "int32"
},
"customDataPropertyDefinitionId": {
"type": "string",
"format": "uuid"
},
"description": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Texting.Service.Commands.TextingMetadata.Result": {
"type": "object",
"properties": {
"textingFeatureEnabled": {
"type": "boolean"
},
"textingPermissionEnabled": {
"type": "boolean"
},
"textingExternalServiceConfigured": {
"type": "boolean"
},
"credentialsExist": {
"type": "boolean"
},
"serviceAlive": {
"type": "boolean"
},
"messageLength": {
"type": "integer",
"format": "int32",
"nullable": true
},
"vendorSpecificMetadata": {
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Texting.Service.Commands.WebhookDataCommand.ITextingWebhookResult": {
"type": "object",
"properties": {
"unprocessedTextMessageId": {
"type": "integer",
"format": "int64"
}
},
"additionalProperties": false
},
"TwApi.Services.Texting.Service.Commands.ZipWhip.v1.CreateTextSessionKeyCommand.Response": {
"type": "object",
"properties": {
"sessionKey": {
"type": "string",
"nullable": true
},
"webhookRefreshHangfireJobId": {
"type": "string",
"nullable": true
},
"webhookExpiresUTC": {
"type": "string",
"format": "date-time",
"nullable": true
},
"srIdentToEdit": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Texting.Service.Commands.ZipWhip.v1.ReceiveTextMessageCommand.Response": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"nullable": true
},
"hasError": {
"type": "boolean",
"readOnly": true
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Common.Validation.TwValidationEntry"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Texting.Service.Commands.ZipWhip.v1.SendTextMessageCommand.Result": {
"type": "object",
"properties": {
"responseData": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.ZipWhip.Service.Models.TWResponseData"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Timeclock.Service.Commands.TimeclockPhoneAssignmentsSummariesQuery.Result": {
"type": "object",
"properties": {
"assignmentId": {
"type": "integer",
"format": "int64"
},
"jobOrderId": {
"type": "integer",
"format": "int64"
},
"customerId": {
"type": "integer",
"format": "int64"
},
"customerAddressId": {
"type": "integer",
"format": "int32"
},
"customerName": {
"type": "string",
"nullable": true
},
"departmentName": {
"type": "string",
"nullable": true
},
"worksiteName": {
"type": "string",
"nullable": true
},
"payCodeId": {
"type": "integer",
"format": "int32"
},
"costCode": {
"type": "string",
"nullable": true
},
"jobTitleId": {
"type": "integer",
"format": "int32"
},
"jobTitle": {
"type": "string",
"nullable": true
},
"phonePunchable": {
"type": "boolean"
},
"startDate": {
"type": "string",
"format": "date-time"
},
"endDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"payRate": {
"type": "number",
"format": "double"
},
"supervisor": {
"type": "string",
"nullable": true
},
"supervisorContactInfo": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Vendors.API.Models.CreateCompanyRequest": {
"required": [
"companyName",
"vendorType"
],
"type": "object",
"properties": {
"vendorType": {
"minLength": 1,
"pattern": "1099 Employee|Subcontractor|Other",
"type": "string",
"description": ""
},
"associatedEmployeeId": {
"type": "integer",
"description": "An existing employee to be linked to the vendor. Only can be used when creating 1099 Employee vendors.",
"format": "int64",
"nullable": true
},
"companyName": {
"maxLength": 200,
"minLength": 0,
"type": "string",
"description": ""
},
"phoneNumberCountryCallingCode": {
"type": "integer",
"description": "",
"format": "int32"
},
"phoneNumber": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "",
"nullable": true
},
"emailAddress": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "",
"nullable": true
},
"contactId": {
"type": "integer",
"description": "A contactId is given if that existing contact should be linked to this company upon creation",
"format": "int32",
"nullable": true
},
"contactFirstName": {
"maxLength": 25,
"minLength": 0,
"type": "string",
"description": "A contactFirstName is given if a new contact should be created and linked to this company upon creation",
"nullable": true
},
"contactLastName": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "A contactLastName is given if a new contact should be created and linked to this company upon creation",
"nullable": true
},
"businessCodeId": {
"type": "string",
"description": "",
"format": "uuid",
"nullable": true
},
"vendorAccountNumber": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "",
"nullable": true
},
"fedEmployerId": {
"maxLength": 20,
"minLength": 0,
"type": "string",
"description": "",
"nullable": true
},
"payBeginningDate": {
"type": "string",
"description": "",
"format": "date-time",
"nullable": true
},
"payDelayInDays": {
"type": "integer",
"description": "",
"format": "int32"
},
"paymentTermsCodeId": {
"type": "integer",
"description": "",
"format": "int32"
},
"corporateStreet1": {
"maxLength": 45,
"minLength": 0,
"type": "string",
"description": "",
"nullable": true
},
"corporateStreet2": {
"maxLength": 45,
"minLength": 0,
"type": "string",
"description": "",
"nullable": true
},
"corporateMunicipality": {
"maxLength": 45,
"minLength": 0,
"type": "string",
"description": "",
"nullable": true
},
"corporateRegion": {
"maxLength": 8,
"minLength": 0,
"type": "string",
"description": "",
"nullable": true
},
"corporatePostalCode": {
"maxLength": 10,
"minLength": 0,
"type": "string",
"description": "",
"nullable": true
},
"corporateCountry": {
"maxLength": 25,
"minLength": 0,
"type": "string",
"description": "",
"nullable": true
},
"corporateCountryCode": {
"type": "integer",
"description": "",
"format": "int32"
},
"localStreet1": {
"maxLength": 45,
"minLength": 0,
"type": "string",
"description": "",
"nullable": true
},
"localStreet2": {
"maxLength": 45,
"minLength": 0,
"type": "string",
"description": "",
"nullable": true
},
"localMunicipality": {
"maxLength": 45,
"minLength": 0,
"type": "string",
"description": "",
"nullable": true
},
"localRegion": {
"maxLength": 8,
"minLength": 0,
"type": "string",
"description": "",
"nullable": true
},
"localPostalCode": {
"maxLength": 10,
"minLength": 0,
"type": "string",
"description": "",
"nullable": true
},
"localCountry": {
"maxLength": 25,
"minLength": 0,
"type": "string",
"description": "",
"nullable": true
},
"localCountryCode": {
"type": "integer",
"description": "",
"format": "int32"
},
"remittanceStreet1": {
"maxLength": 45,
"minLength": 0,
"type": "string",
"description": "",
"nullable": true
},
"remittanceStreet2": {
"maxLength": 45,
"minLength": 0,
"type": "string",
"description": "",
"nullable": true
},
"remittanceMunicipality": {
"maxLength": 45,
"minLength": 0,
"type": "string",
"description": "",
"nullable": true
},
"remittanceRegion": {
"maxLength": 8,
"minLength": 0,
"type": "string",
"description": "",
"nullable": true
},
"remittancePostalCode": {
"maxLength": 10,
"minLength": 0,
"type": "string",
"description": "",
"nullable": true
},
"remittanceCountry": {
"maxLength": 25,
"minLength": 0,
"type": "string",
"description": "",
"nullable": true
},
"remittanceCountryCode": {
"type": "integer",
"description": "",
"format": "int32"
},
"note": {
"maxLength": 1000,
"minLength": 0,
"type": "string",
"description": "",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to create a new Company."
},
"TwApi.Services.Vendors.API.Models.PostIndeedApplyIngestRequestModel": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique Id for the application assigned by Indeed.",
"nullable": true
},
"applicant": {
"$ref": "#/components/schemas/TwApi.Services.Vendors.API.Models.PostIndeedApplyIngestRequestModel.ApplicantModel"
},
"appliedOnMillis": {
"type": "integer",
"description": "The date and time the user applied expressed in standard Unix time.",
"format": "int64"
},
"job": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestJob"
},
"analytics": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestAnalytics"
},
"locale": {
"type": "string",
"description": "The locale that was used when applying to the job.",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.Vendors.API.Models.PostIndeedApplyIngestRequestModel.ApplicantModel": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "The email of the applicant.",
"nullable": true
},
"fullName": {
"type": "string",
"description": "The name of the applicant. If the user is using their Indeed Resume, this will be their firstName + lastName.",
"nullable": true
},
"firstName": {
"type": "string",
"description": "The first name of the applicant. An Indeed config will need to be sent to Indeed in order to get this property back.",
"nullable": true
},
"lastName": {
"type": "string",
"description": "The last name of the applicant. An Indeed config will need to be sent to Indeed in order to get this property back.",
"nullable": true
},
"phoneNumber": {
"type": "string",
"description": "The phoneNumber if provided by the applicant.",
"nullable": true
},
"verified": {
"type": "boolean",
"description": "A flag indicating whether a job seeker’s email address is verified. Will display true if:\r\n the user is logged into a verified account, and their email address on the application matches the email address associated with the account, or\r\n the user is logged out but their email has been verified by a one-time password\r\nAll other cases, the flag will be set to false."
},
"resume": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume"
}
},
"additionalProperties": false
},
"TwApi.Services.Vendors.API.Models.SovrenImportRequestCustomInfo": {
"type": "object",
"properties": {
"srIdent": {
"type": "integer",
"description": "The SrIdent of the ApiUser who made the request",
"format": "int32"
},
"tenantName": {
"type": "string",
"description": "The TenantName of the ApiUser who made the request",
"nullable": true
},
"organizationName": {
"type": "string",
"description": "The OrganizationName of the ApiUser who made the request",
"nullable": true
},
"targetOrigin": {
"type": "string",
"description": "The Origin Url is used by the Sovren UI in the PostMessage() call",
"nullable": true
}
},
"additionalProperties": false,
"description": "Custom Data that is pass as part of the Sovren Sourcing Hook"
},
"TwApi.Services.Vendors.API.Models.SovrenResumeImportRequest": {
"required": [
"parsedDocument"
],
"type": "object",
"properties": {
"jobBoard": {
"type": "string",
"description": "The source of the document",
"nullable": true
},
"jobBoardDocumentId": {
"type": "string",
"description": "The Sovren Document Id",
"nullable": true
},
"sourceDocument": {
"type": "string",
"description": "Text version of parsed document",
"nullable": true
},
"parsedDocument": {
"minLength": 1,
"type": "string",
"description": "The document to be imported"
},
"username": {
"type": "string",
"description": "The Sovren account that made the request",
"nullable": true
},
"customInfo": {
"$ref": "#/components/schemas/TwApi.Services.Vendors.API.Models.SovrenImportRequestCustomInfo"
}
},
"additionalProperties": false,
"description": "A request to Import a document from a sourcing Iframe"
},
"TwApi.Services.Vendors.Service.Commands.CompanyDetailsQuery.Result": {
"type": "object",
"properties": {
"companyId": {
"type": "integer",
"format": "int32"
},
"accountId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"activationDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"vendorType": {
"type": "string",
"nullable": true
},
"businessCodeId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"businessCode": {
"type": "string",
"nullable": true
},
"certificateOnFile": {
"type": "boolean"
},
"companyAddress": {
"type": "string",
"nullable": true
},
"phoneNumberCountryCallingCode": {
"type": "integer",
"format": "int32"
},
"phoneNumber": {
"type": "string",
"nullable": true
},
"contactName": {
"type": "string",
"nullable": true
},
"contractEndDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"contractStartDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"corporateAddress": {
"$ref": "#/components/schemas/TempWorks.TwApi.Common.Models.Address"
},
"creditLimit": {
"type": "number",
"format": "double",
"nullable": true
},
"isDefaultCompany": {
"type": "boolean"
},
"departmentName": {
"type": "string",
"nullable": true
},
"employerId": {
"type": "integer",
"format": "int32"
},
"emailAddress": {
"type": "string",
"nullable": true
},
"fedEmployerId": {
"type": "string",
"nullable": true
},
"companyName": {
"type": "string",
"nullable": true
},
"shouldGenerate1099": {
"type": "boolean"
},
"isInvoicePayRequired": {
"type": "boolean"
},
"isPayrollDedVendor": {
"type": "boolean"
},
"isPayrollSalesTaxVendor": {
"type": "boolean"
},
"isPayrollTaxVendor": {
"type": "boolean"
},
"localAddress": {
"$ref": "#/components/schemas/TempWorks.TwApi.Common.Models.Address"
},
"isMinorityOwned": {
"type": "boolean"
},
"note": {
"type": "string",
"nullable": true
},
"payBeginningDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"payDelayInDays": {
"type": "integer",
"format": "int32"
},
"paymentTermsCodeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"paymentTerms": {
"type": "string",
"nullable": true
},
"associatedEmployeeId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"associatedEmployeeFirstName": {
"type": "string",
"nullable": true
},
"associatedEmployeeLastName": {
"type": "string",
"nullable": true
},
"remittanceAddress": {
"$ref": "#/components/schemas/TempWorks.TwApi.Common.Models.Address"
},
"isSBARegistered": {
"type": "boolean"
},
"isSmallBusiness": {
"type": "boolean"
},
"status": {
"type": "string",
"nullable": true
},
"vendorAccountNumber": {
"type": "string",
"nullable": true
},
"isWomenOwned": {
"type": "boolean"
},
"companyRootGuid": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"TwApi.Services.Vendors.Service.Commands.CreateCompanyCommand.Result": {
"type": "object",
"properties": {
"companyId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Services.Vendors.Service.Commands.VendorContactsQuery.Result": {
"type": "object",
"properties": {
"contactId": {
"type": "integer",
"format": "int32"
},
"lastName": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"officePhoneCountryCallingCode": {
"type": "integer",
"format": "int32",
"nullable": true
},
"officePhone": {
"type": "string",
"nullable": true
},
"emailAddress": {
"type": "string",
"nullable": true
},
"cellPhoneCountryCallingCode": {
"type": "integer",
"format": "int32",
"nullable": true
},
"cellPhone": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Services.YearEnd.Service.Commands.YearEndEmployeeTaxForms.Result": {
"type": "object",
"properties": {
"year": {
"type": "integer",
"format": "int32"
},
"taxFormTypeId": {
"type": "integer",
"format": "int32"
},
"taxFormType": {
"type": "string",
"nullable": true
},
"employerId": {
"type": "integer",
"format": "int32"
},
"employer": {
"type": "string",
"nullable": true
},
"canGenerateForm": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.YearEnd.Service.Commands.YearEndTaxFormTypes.Result": {
"type": "object",
"properties": {
"taxFormTypeId": {
"type": "integer",
"format": "int32"
},
"taxFormTypeName": {
"type": "string",
"nullable": true
},
"isEmployeeRelevant": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Services.ZipWhip.API.Models.CreateSessionKeyRequest": {
"required": [
"password",
"srIdent",
"username"
],
"type": "object",
"properties": {
"username": {
"minLength": 1,
"type": "string",
"description": "ZipWhip account username"
},
"password": {
"minLength": 1,
"type": "string",
"description": "ZipWhip account password"
},
"srIdent": {
"type": "integer",
"description": "Service rep to create token for, used for setting up webhook",
"format": "int32"
}
},
"additionalProperties": false,
"description": "A request to get a key that will allow the user to send text messages."
},
"TwApi.Services.ZipWhip.API.Models.ReceiveMessageRequest": {
"type": "object",
"properties": {
"body": {
"type": "string",
"description": "The message that was sent. This value is required.",
"nullable": true
},
"bodySize": {
"type": "integer",
"description": "# bytes in body",
"format": "int32"
},
"visible": {
"type": "boolean",
"description": "Is message visible?"
},
"hasAttachment": {
"type": "boolean",
"description": "Did message include an attachment?"
},
"dateRead": {
"type": "string",
"description": "When was message read?",
"format": "date-time",
"nullable": true
},
"bcc": {
"type": "string",
"description": "Blind copy recipients",
"nullable": true
},
"finalDestination": {
"type": "string",
"description": "Destination phone number. This value is required.",
"nullable": true
},
"messageType": {
"type": "string",
"description": "Type of message (ZO = Send, MO = Receive)",
"nullable": true
},
"deleted": {
"type": "boolean",
"description": "Was message deleted?"
},
"statusCode": {
"type": "integer",
"description": "A status code indicating the state of the message.",
"format": "int32"
},
"id": {
"type": "integer",
"description": "Unique message Id. This value is required.",
"format": "int64",
"nullable": true
},
"scheduledDate": {
"type": "string",
"description": "Date for scheduled message",
"format": "date-time",
"nullable": true
},
"fingerprint": {
"type": "string",
"description": "The unique identifier for a conversation.",
"nullable": true
},
"messageTransport": {
"type": "integer",
"description": "Unknown at this time.",
"format": "int32"
},
"contactId": {
"type": "integer",
"description": "Unknown at this time.",
"format": "int64"
},
"address": {
"type": "string",
"description": "Uri-based description of finalSource?",
"nullable": true
},
"read": {
"type": "string",
"description": "Indicates whether or not the message has been marked as read by Zip Whip.",
"nullable": true
},
"dateCreated": {
"type": "string",
"description": "Date and time message created. This value is required.",
"format": "date-time",
"nullable": true
},
"dateDeleted": {
"type": "string",
"description": "Date and time message deleted",
"format": "date-time",
"nullable": true
},
"dateDelivered": {
"type": "string",
"description": "Date and time message was delivered",
"format": "date-time",
"nullable": true
},
"cc": {
"type": "string",
"description": "CC list",
"nullable": true
},
"finalSource": {
"type": "string",
"description": "Source phone number. This value is required.",
"nullable": true
},
"deviceId": {
"type": "string",
"description": "An identifier for the device the message was sent from.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request used to receive a response message back from the texting service used. Please refer to https://developers.zipwhip.com/\r\nas a final authority as to what these mean."
},
"TwApi.Services.ZipWhip.API.Models.SendMessageRequest": {
"required": [
"message",
"recipients"
],
"type": "object",
"properties": {
"recipients": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.ExternalIntegrations.ZipWhip.Service.Models.TextMessageRecipient"
},
"description": "A list of recipients of the text message."
},
"message": {
"minLength": 1,
"type": "string",
"description": "The text message to be sent."
},
"sessionKey": {
"type": "string",
"description": "The Session Key retrieved from the text/message/sessionKey endpoint.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A request to send a text message."
},
"TwApi.Shared.Commands.AssignmentRestrictions.CreateEmployeeCustomerDoNotAssign.Result": {
"type": "object",
"properties": {
"doNotAssignId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.ContactMethods.CreateEntityContactMethodCommand.Result": {
"type": "object",
"properties": {
"contactMethodId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.CustomData.EntityCustomDataQuery.Result": {
"type": "object",
"properties": {
"propertyDefinitionId": {
"type": "string",
"format": "uuid"
},
"propertyName": {
"type": "string",
"nullable": true
},
"propertyValue": {
"nullable": true
},
"propertyValueId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"propertyType": {
"type": "string",
"nullable": true
},
"categoryId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"categoryName": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"isRequired": {
"type": "boolean"
},
"isReadOnly": {
"type": "boolean"
},
"allowMultipleValues": {
"type": "boolean"
},
"hasDatalist": {
"type": "boolean"
},
"employeeRootGuid": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.CustomData.EntityCustomDataSearch.Result": {
"type": "object",
"properties": {
"propertyDefinitionId": {
"type": "string",
"format": "uuid"
},
"propertyName": {
"type": "string",
"nullable": true
},
"propertyValue": {
"nullable": true
},
"propertyValueId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"propertyType": {
"type": "string",
"nullable": true
},
"categoryId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"categoryName": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"isRequired": {
"type": "boolean"
},
"isReadOnly": {
"type": "boolean"
},
"allowMultipleValues": {
"type": "boolean"
},
"hasDatalist": {
"type": "boolean"
},
"originId": {
"type": "integer",
"format": "int64",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.AdjustmentsListQuery.Result": {
"type": "object",
"properties": {
"adjustmentId": {
"type": "integer",
"format": "int32"
},
"adjustment": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"description": {
"type": "string",
"nullable": true
},
"adjustmentCategory": {
"type": "string",
"nullable": true
},
"isTimecardAdjustment": {
"type": "boolean"
},
"isRecurringAdjustment": {
"type": "boolean"
},
"defaultSequence": {
"type": "integer",
"format": "int32",
"nullable": true
},
"defaultMaximumLifetimeTakeAmount": {
"type": "number",
"format": "double"
},
"defaultMaximumYearlyTakeAmount": {
"type": "number",
"format": "double"
},
"defaultMaximumMonthlyTakeAmount": {
"type": "number",
"format": "double",
"nullable": true
},
"defaultMaximumPerPeriodTakeAmount": {
"type": "number",
"format": "double",
"nullable": true
},
"defaultFrequencyId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"requiresAuthority": {
"type": "boolean"
},
"isDirectDepositAdjustment": {
"type": "boolean"
},
"isHourlyAdjustment": {
"type": "boolean"
},
"isLevy": {
"type": "boolean"
},
"isAdjustmentToNet": {
"type": "boolean"
},
"isAdjustmentToGross": {
"type": "boolean"
},
"usesRuleCases": {
"type": "boolean"
},
"isEarnedWageAccessAdjustment": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.AvailableKpiReportList.Result": {
"type": "object",
"properties": {
"reportId": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"reportTypeId": {
"type": "integer",
"format": "int32"
},
"reportType": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.BranchListQuery.Result": {
"type": "object",
"properties": {
"branchId": {
"type": "integer",
"format": "int32"
},
"branchName": {
"type": "string",
"nullable": true
},
"branchFullName": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"emailAddress": {
"type": "string",
"nullable": true
},
"phoneNumber": {
"type": "string",
"nullable": true
},
"address": {
"$ref": "#/components/schemas/TempWorks.TwApi.Common.Models.Address"
},
"region": {
"type": "string",
"nullable": true
},
"employerId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.BurdenTypeListQuery.Result": {
"type": "object",
"properties": {
"burdenTypeId": {
"type": "integer",
"format": "int32"
},
"burdenType": {
"type": "string",
"nullable": true
},
"burdenAmount": {
"type": "number",
"format": "double"
},
"burdenAmountTypeId": {
"type": "integer",
"format": "int32"
},
"burdenAmountType": {
"type": "string",
"nullable": true
},
"isCalculatedOnPay": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.BusinessCodeListQuery.Result": {
"type": "object",
"properties": {
"businessCodeId": {
"type": "string",
"format": "uuid"
},
"businessCode": {
"type": "string",
"nullable": true
},
"businessCodeDescription": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.CompanyListQuery.Result": {
"type": "object",
"properties": {
"companyId": {
"type": "integer",
"format": "int32"
},
"companyName": {
"type": "string",
"nullable": true
},
"departmentName": {
"type": "string",
"nullable": true
},
"companyTypeId": {
"type": "string",
"format": "uuid"
},
"companyType": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"einc": {
"type": "integer",
"format": "int32"
},
"isAssignable": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.ContactMethodTypeListQuery.Result": {
"type": "object",
"properties": {
"contactMethodTypeId": {
"type": "integer",
"format": "int32"
},
"description": {
"type": "string",
"nullable": true
},
"contactMethodGroupTypeId": {
"type": "integer",
"format": "int32"
},
"contactMethodGroupType": {
"type": "string",
"nullable": true
},
"isEmployeeMainPhoneNumber": {
"type": "boolean"
},
"isMainEmailAddress": {
"type": "boolean"
},
"isCellPhoneNumber": {
"type": "boolean"
},
"isSMSEmail": {
"type": "boolean"
},
"isEmployeeRelevant": {
"type": "boolean"
},
"isContactRelevant": {
"type": "boolean"
},
"isCustomerRelevant": {
"type": "boolean"
},
"isOfficePhoneNumber": {
"type": "boolean"
},
"isFaxNumber": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.CountryCallingCodeListQuery.Result": {
"type": "object",
"properties": {
"countryName": {
"type": "string",
"nullable": true
},
"countryCode": {
"type": "integer",
"format": "int32"
},
"countryCallingCode": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.CountryListQuery.Result": {
"type": "object",
"properties": {
"countryCode": {
"type": "integer",
"format": "int32"
},
"country": {
"type": "string",
"nullable": true
},
"countryCallingCode": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.CountyTaxJurisdictionListQuery.Result": {
"type": "object",
"properties": {
"taxJurisdictionId": {
"type": "integer",
"format": "int32"
},
"taxJurisdiction": {
"type": "string",
"nullable": true
},
"county": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.CustomDataDatalistQuery.Result": {
"type": "object",
"properties": {
"value": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.CustomerStatusListQuery.Result": {
"type": "object",
"properties": {
"customerStatusId": {
"type": "string",
"nullable": true
},
"customerStatus": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.DateFormatListQuery.Result": {
"type": "object",
"properties": {
"dateFormatId": {
"type": "integer",
"format": "int32"
},
"dateFormat": {
"type": "string",
"nullable": true
},
"microsoftDateFormat": {
"type": "string",
"nullable": true
},
"momentDateFormat": {
"type": "string",
"nullable": true
},
"microsoftLongDateFormat": {
"type": "string",
"nullable": true
},
"momentLongDateFormat": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.DistanceUnitList.Result": {
"type": "object",
"properties": {
"distanceUnitId": {
"type": "integer",
"format": "int64"
},
"distanceUnit": {
"type": "string",
"nullable": true
},
"unitsPerMeter": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.DivisionListQuery.Result": {
"type": "object",
"properties": {
"divisionCode": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"profitAdmin": {
"type": "string",
"nullable": true
},
"lBondingRate": {
"type": "number",
"format": "double"
},
"minGPPct": {
"type": "number",
"format": "double",
"nullable": true
},
"divisionIdent": {
"type": "integer",
"format": "int32"
},
"divisionGuid": {
"type": "string",
"format": "uuid"
},
"isDefault": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.EEOClassListQuery.Result": {
"type": "object",
"properties": {
"eeoClass": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"eeoSort": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.EmployeeStatusListQuery.Result": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"status": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"active": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.EmployerListQuery.Result": {
"type": "object",
"properties": {
"employerId": {
"type": "integer",
"format": "int32"
},
"employerGuid": {
"type": "string",
"format": "uuid"
},
"legalName": {
"type": "string",
"nullable": true
},
"employerName": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.EmploymentCategoryListQuery.Result": {
"type": "object",
"properties": {
"employmentCategoryId": {
"type": "string",
"format": "uuid"
},
"category": {
"type": "string",
"nullable": true
},
"active": {
"type": "boolean"
},
"isDefault": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.ExternalServiceEncryptionTypeListQuery.Result": {
"type": "object",
"properties": {
"encryptionTypeId": {
"type": "integer",
"format": "int64"
},
"encryptionType": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.ExternalServiceVisibilityMethodsListQuery.Result": {
"type": "object",
"properties": {
"visibilityMethodId": {
"type": "integer",
"format": "int64"
},
"visibilityMethod": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.ExternalServicesListQuery.Result": {
"type": "object",
"properties": {
"externalServiceId": {
"type": "integer",
"format": "int64"
},
"externalService": {
"type": "string",
"nullable": true
},
"visibilityMethodId": {
"type": "integer",
"format": "int64"
},
"visibilityMethod": {
"type": "string",
"nullable": true
},
"defaultEncryptionTypeId": {
"type": "integer",
"format": "int64"
},
"defaultEncryptionType": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.FrequencyListQuery.Result": {
"type": "object",
"properties": {
"frequencyId": {
"type": "integer",
"format": "int32"
},
"frequency": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.GenderListQuery.Result": {
"type": "object",
"properties": {
"genderId": {
"type": "integer",
"format": "int32"
},
"gender": {
"type": "string",
"nullable": true
},
"genderDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.GetAvailableEmployerPortionAdjustments.Result": {
"type": "object",
"properties": {
"adjustmentId": {
"type": "integer",
"format": "int32"
},
"adjustmentName": {
"type": "string",
"nullable": true
},
"adjustmentDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.GetDocumentTypesQuery.Result": {
"type": "object",
"properties": {
"documentTypeId": {
"type": "integer",
"format": "int32"
},
"description": {
"type": "string",
"nullable": true
},
"isResume": {
"type": "boolean"
},
"isMarketing": {
"type": "boolean"
},
"isDocumentation": {
"type": "boolean"
},
"isI9": {
"type": "boolean"
},
"isW4": {
"type": "boolean"
},
"isTimecardDocument": {
"type": "boolean"
},
"isTimecardAdjustmentDocument": {
"type": "boolean"
},
"canRead": {
"type": "boolean"
},
"canWrite": {
"type": "boolean"
},
"canDelete": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.GetRequiredDocumentCategories.Result": {
"type": "object",
"properties": {
"requiredDocumentTypeCategoryId": {
"type": "string",
"format": "uuid"
},
"requiredDocumentTypeCategory": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.GetRequiredDocumentStatus.Result": {
"type": "object",
"properties": {
"requiredDocumentStatusId": {
"type": "string",
"format": "uuid"
},
"requiredDocumentStatus": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.HierListQuery.Result": {
"type": "object",
"properties": {
"hierId": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"hierTypeName": {
"type": "string",
"nullable": true
},
"hierTypeId": {
"type": "integer",
"format": "int32"
},
"hierGuid": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.HowHeardOfListQuery.Result": {
"type": "object",
"properties": {
"howHeardOfId": {
"type": "integer",
"format": "int32"
},
"howHeardOf": {
"type": "string",
"nullable": true
},
"isEmployeeRelevant": {
"type": "boolean"
},
"isContactRelevant": {
"type": "boolean"
},
"isCustomerRelevant": {
"type": "boolean"
},
"active": {
"type": "boolean"
},
"promptForDetails": {
"type": "boolean"
},
"requireDetails": {
"type": "boolean"
},
"isWebPublic": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.InterestCodeListQuery.Result": {
"type": "object",
"properties": {
"interestCodeId": {
"type": "integer",
"format": "int32"
},
"interestCode": {
"type": "string",
"nullable": true
},
"note": {
"type": "string",
"nullable": true
},
"active": {
"type": "boolean"
},
"isWebPublic": {
"type": "boolean"
},
"subCategoryId": {
"type": "integer",
"format": "int32"
},
"subCategory": {
"type": "string",
"nullable": true
},
"originTypeId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.InterestCodeSubCategoryList.Result": {
"type": "object",
"properties": {
"subCategoryId": {
"type": "integer",
"format": "int32"
},
"subCategory": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"isWebPublic": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.InvoicingMethodListQuery.Result": {
"type": "object",
"properties": {
"invoicingMethodId": {
"type": "integer",
"format": "int32"
},
"invoicingMethod": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"isDefault": {
"type": "boolean"
},
"invoicesWillBePrinted": {
"type": "boolean"
},
"invoicesWillBeEmailed": {
"type": "boolean"
},
"timecardImagesWillBeAttached": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.JobOrderCompanyStatusList.Result": {
"type": "object",
"properties": {
"status": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.JobTitleListQuery.Result": {
"type": "object",
"properties": {
"jobTitleId": {
"type": "integer",
"format": "int32"
},
"jobTitle": {
"type": "string",
"nullable": true
},
"skillCode": {
"type": "string",
"nullable": true
},
"isPublic": {
"type": "boolean"
},
"isDefault": {
"type": "boolean"
},
"isActive": {
"type": "boolean"
},
"hierarchyDescription": {
"type": "string",
"nullable": true
},
"jobTitleCategoryId": {
"type": "integer",
"format": "int32"
},
"jobTitleCategory": {
"type": "string",
"nullable": true
},
"localizedJobTitles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TempWorks.TwApi.Common.Models.LocalizedJobTitles"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.LocalTaxJurisdictionsByPostalCodeQuery.Result": {
"type": "object",
"properties": {
"taxRegion": {
"type": "string",
"nullable": true
},
"taxCounty": {
"type": "string",
"nullable": true
},
"taxCountyId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"taxCountyJurisdiction": {
"type": "string",
"nullable": true
},
"taxCountyJurisdictionId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"taxMunicipality": {
"type": "string",
"nullable": true
},
"taxMunicipalityId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"taxMunicipalityJurisdiction": {
"type": "string",
"nullable": true
},
"taxMunicipalityJurisdictionId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"taxSchoolDistrict": {
"type": "string",
"nullable": true
},
"taxSchoolDistrictId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"taxSchoolDistrictJurisdiction": {
"type": "string",
"nullable": true
},
"taxSchoolDistrictJurisdictionId": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.LocaleListQuery.Result": {
"type": "object",
"properties": {
"localeId": {
"type": "string",
"nullable": true
},
"locale": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.MessageActionListQuery.Result": {
"type": "object",
"properties": {
"actionId": {
"type": "integer",
"format": "int32"
},
"action": {
"type": "string",
"nullable": true
},
"actionDescription": {
"type": "string",
"nullable": true
},
"isDefault": {
"type": "boolean"
},
"isEmployeeRelevant": {
"type": "boolean"
},
"isCustomerRelevant": {
"type": "boolean"
},
"isContactRelevant": {
"type": "boolean"
},
"isDeact": {
"type": "boolean"
},
"isReact": {
"type": "boolean"
},
"isAvailability": {
"type": "boolean"
},
"isDefaultDeactCode": {
"type": "boolean"
},
"isDefaultReactCode": {
"type": "boolean"
},
"isDefaultEmailCode": {
"type": "boolean"
},
"isDefaultLMTC": {
"type": "boolean"
},
"isActive": {
"type": "boolean"
},
"isDoNotAssign": {
"type": "boolean"
},
"messageActionTypeId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"messageActionType": {
"type": "string",
"nullable": true
},
"displayColor": {
"type": "string",
"nullable": true
},
"canRead": {
"type": "boolean"
},
"canWrite": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.MessageActionTypeListQuery.Result": {
"type": "object",
"properties": {
"messageActionTypeId": {
"type": "string",
"format": "uuid"
},
"messageActionType": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"displayColor": {
"type": "string",
"nullable": true
},
"canRead": {
"type": "boolean"
},
"canWrite": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.MultiplierCodeListQuery.Result": {
"type": "object",
"properties": {
"multiplierCodeId": {
"type": "integer",
"format": "int32"
},
"multiplierCode": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"isDefault": {
"type": "boolean"
},
"regularMarkup": {
"type": "number",
"format": "double"
},
"overtimeMarkup": {
"type": "number",
"format": "double"
},
"overtimeMarkupMultiplier": {
"type": "number",
"format": "double"
},
"doubletimeMarkup": {
"type": "number",
"format": "double"
},
"doubletimeMarkupMultiplier": {
"type": "number",
"format": "double"
},
"calculateBillRateFromPayRate": {
"type": "boolean"
},
"calculatePayRateFromBillRate": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.MunicipalityTaxJurisdictionListQuery.Result": {
"type": "object",
"properties": {
"taxJurisdictionId": {
"type": "integer",
"format": "int32"
},
"taxJurisdiction": {
"type": "string",
"nullable": true
},
"municipality": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.NamePrefixListQuery.Result": {
"type": "object",
"properties": {
"prefix": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.NationalityListQuery.Result": {
"type": "object",
"properties": {
"nationalityId": {
"type": "integer",
"format": "int32"
},
"nationality": {
"type": "string",
"nullable": true
},
"countryCode": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.NotificationTypesListQuery.Result": {
"type": "object",
"properties": {
"originTypeId": {
"type": "integer",
"format": "int32"
},
"notificationTypeId": {
"type": "integer",
"format": "int32"
},
"notificationTypeName": {
"type": "string",
"nullable": true
},
"notificationTypeDescription": {
"type": "string",
"nullable": true
},
"notificationCategoryId": {
"type": "integer",
"format": "int32"
},
"notificationCategoryName": {
"type": "string",
"nullable": true
},
"notificationCategoryDescription": {
"type": "string",
"nullable": true
},
"notificationMethodId": {
"type": "integer",
"format": "int32"
},
"notificationMethodName": {
"type": "string",
"nullable": true
},
"notificationMethodDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.OrderTypeListQuery.Result": {
"type": "object",
"properties": {
"orderTypeId": {
"type": "integer",
"format": "int32"
},
"orderType": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"isDirectHire": {
"type": "boolean"
},
"isDefault": {
"type": "boolean"
},
"isDailyPayDefault": {
"type": "boolean"
},
"defaultPayPeriods": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.OvertimeFactorListQuery.Result": {
"type": "object",
"properties": {
"overtimeFactor": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.OvertimePlanListQuery.Result": {
"type": "object",
"properties": {
"overtimePlanId": {
"type": "integer",
"format": "int32"
},
"overtimePlan": {
"type": "string",
"nullable": true
},
"overtimePlanType": {
"type": "string",
"nullable": true
},
"overtimeAfter": {
"type": "number",
"format": "double"
},
"doubletimeAfter": {
"type": "number",
"format": "double"
},
"doubletimeRule": {
"type": "boolean"
},
"maxRegularHours": {
"type": "number",
"format": "double"
},
"maxOvertimeHours": {
"type": "number",
"format": "double"
},
"payPeriods": {
"type": "integer",
"format": "int32"
},
"isDefault": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.ParentTaxJurisdictionListQuery.Result": {
"type": "object",
"properties": {
"parentTaxJurisdiction": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.PayPeriodDataListQuery.Result": {
"type": "object",
"properties": {
"payPeriods": {
"type": "integer",
"format": "int32"
},
"payPeriodsDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.PaycardVendorsListQuery.Result": {
"type": "object",
"properties": {
"description": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"paycardVendorId": {
"type": "integer",
"format": "int32"
},
"paycardVendorName": {
"type": "string",
"nullable": true
},
"paycardNumberLength": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.PaymentTermsListQuery.Result": {
"type": "object",
"properties": {
"paymentTermsCodeId": {
"type": "integer",
"format": "int32"
},
"paymentTerms": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.PennsylvaniaLocalServiceTaxListQuery.Result": {
"type": "object",
"properties": {
"pennsylvaniaLocalServiceTaxId": {
"type": "string",
"format": "uuid"
},
"pennsylvaniaLocalServiceTax": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.PennsylvaniaPsdCodesListQuery.Result": {
"type": "object",
"properties": {
"psdCode": {
"type": "string",
"nullable": true
},
"taxSchoolDistrict": {
"type": "string",
"nullable": true
},
"taxSchoolDistrictJurisdictionId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"taxSchoolDistrictJurisdiction": {
"type": "string",
"nullable": true
},
"taxMunicipality": {
"type": "string",
"nullable": true
},
"taxMunicipalityJurisdictionId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"taxMunicipalityJurisdiction": {
"type": "string",
"nullable": true
},
"taxDistrict": {
"type": "string",
"nullable": true
},
"county": {
"type": "string",
"nullable": true
},
"localServiceTaxId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"localServiceTax": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.PermissionsListQuery.Result": {
"type": "object",
"properties": {
"permissionId": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"tags": {
"type": "string",
"nullable": true
},
"requirePermissionAdmin": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.ProductInstanceListQuery.Result": {
"type": "object",
"properties": {
"productInstanceId": {
"type": "string",
"format": "uuid"
},
"productId": {
"$ref": "#/components/schemas/TwApi.Common.Enums.Products"
},
"product": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"isDeprecated": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.ProductList.Result": {
"type": "object",
"properties": {
"productId": {
"type": "integer",
"format": "int32"
},
"product": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.ProofingErrorTypeSeverities.ProofingErrorTypeSeverities.Result": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"severity": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.RegionListQuery.Result": {
"type": "object",
"properties": {
"region": {
"type": "string",
"nullable": true
},
"regionName": {
"type": "string",
"nullable": true
},
"countryCode": {
"type": "integer",
"format": "int32"
},
"country": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.RegionTaxJurisdictionListQuery.Result": {
"type": "object",
"properties": {
"taxJurisdictionId": {
"type": "integer",
"format": "int32"
},
"taxJurisdiction": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"region": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.ReportGroupListQuery.Result": {
"type": "object",
"properties": {
"reportGroupId": {
"type": "string",
"format": "uuid"
},
"reportGroup": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.RequiredDocumentAuthorityList.Result": {
"type": "object",
"properties": {
"requiredDocumentAuthorityId": {
"type": "integer",
"format": "int32"
},
"requiredDocumentAuthority": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.RequiredDocumentTypeList.Result": {
"type": "object",
"properties": {
"requiredDocumentTypeId": {
"type": "integer",
"format": "int32"
},
"requiredDocumentTypeName": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"expirationDays": {
"type": "integer",
"format": "int32"
},
"daysWarningBeforeExpire": {
"type": "integer",
"format": "int32"
},
"documentExpiresAtEndOfCalendarYear": {
"type": "boolean"
},
"isActive": {
"type": "boolean"
},
"requiredDocumentTypeCategoryId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"requiredDocumentTypeCategory": {
"type": "string",
"nullable": true
},
"daysAfterIssueToExpire": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.SalesTeamListQuery.Result": {
"type": "object",
"properties": {
"salesTeamId": {
"type": "integer",
"format": "int32"
},
"salesTeam": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"salesTeamGuid": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.SchoolDistrictTaxJurisdictionListQuery.Result": {
"type": "object",
"properties": {
"taxJurisdictionId": {
"type": "integer",
"format": "int32"
},
"taxJurisdiction": {
"type": "string",
"nullable": true
},
"schoolDistrict": {
"type": "string",
"nullable": true
},
"schoolDistrictNumber": {
"type": "integer",
"format": "int32"
},
"schoolDistrictId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.SecurityGroupTypeListQuery.Result": {
"type": "object",
"properties": {
"securityGroupTypeId": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.ServiceRepListQuery.Result": {
"type": "object",
"properties": {
"srIdent": {
"type": "integer",
"format": "int32"
},
"serviceRepGuid": {
"type": "string",
"format": "uuid"
},
"serviceRep": {
"type": "string",
"nullable": true
},
"serviceRepFullName": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"phoneNumber": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.ServiceRepsByPermission.Result": {
"type": "object",
"properties": {
"serviceRepId": {
"type": "integer",
"format": "int32"
},
"serviceRepGuid": {
"type": "string",
"format": "uuid"
},
"serviceRep": {
"type": "string",
"nullable": true
},
"serviceRepFullName": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"isTWEmployee": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.SkillCodeCategoryListQuery.Result": {
"type": "object",
"properties": {
"skillCodeCategoryId": {
"type": "integer",
"format": "int32"
},
"skillCodeCategory": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.SocCodesList.Result": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"fullSocCode": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.SutaTaxJurisdictionListQuery.Result": {
"type": "object",
"properties": {
"taxJurisdictionId": {
"type": "integer",
"format": "int32"
},
"taxJurisdiction": {
"type": "string",
"nullable": true
},
"upperLimit": {
"type": "string",
"nullable": true
},
"percentage": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.TaxJurisdictionListQuery.Result": {
"type": "object",
"properties": {
"jurisdictionId": {
"type": "integer",
"format": "int32"
},
"jurisdiction": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"parentTaxJurisdiction": {
"type": "string",
"nullable": true
},
"compatibleTaxJurisdiction": {
"type": "string",
"nullable": true
},
"taxRegion": {
"type": "string",
"nullable": true
},
"isPaidByEmployee": {
"type": "boolean"
},
"usesAlternativeStandardDeduction": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.TaxJurisdictionLocationListQuery.Result": {
"type": "object",
"properties": {
"postalCode": {
"type": "string",
"nullable": true
},
"cityCode": {
"type": "integer",
"format": "int32",
"nullable": true
},
"city": {
"type": "string",
"nullable": true
},
"cityJuris": {
"type": "string",
"nullable": true
},
"cityJurisId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"schoolDistrictCode": {
"type": "integer",
"format": "int32",
"nullable": true
},
"schoolDistrictNumber": {
"type": "integer",
"format": "int32",
"nullable": true
},
"schoolDistrictName": {
"type": "string",
"nullable": true
},
"schoolJuris": {
"type": "string",
"nullable": true
},
"schoolJurisId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"countyCode": {
"type": "integer",
"format": "int32",
"nullable": true
},
"county": {
"type": "string",
"nullable": true
},
"countyJuris": {
"type": "string",
"nullable": true
},
"countyJurisId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"state": {
"type": "string",
"nullable": true
},
"sutaJuris": {
"type": "string",
"nullable": true
},
"sutaJurisId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"psdCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.TimeFormatListQuery.Result": {
"type": "object",
"properties": {
"timeFormatId": {
"type": "integer",
"format": "int32"
},
"timeFormat": {
"type": "string",
"nullable": true
},
"microsoftTimeFormat": {
"type": "string",
"nullable": true
},
"momentTimeFormat": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.TimezoneListQuery.Result": {
"type": "object",
"properties": {
"timezoneId": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.VeteranStatusListQuery.Result": {
"type": "object",
"properties": {
"veteranStatusId": {
"type": "integer",
"format": "int32"
},
"veteranStatus": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.WashedStatusListQuery.Result": {
"type": "object",
"properties": {
"washedStatusId": {
"type": "integer",
"format": "int32"
},
"description": {
"type": "string",
"nullable": true
},
"longDescription": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.WeekdaysListQuery.Result": {
"type": "object",
"properties": {
"dayId": {
"type": "integer",
"format": "int32"
},
"day": {
"type": "string",
"nullable": true
},
"daySeq": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.WeekendBillList.Result": {
"type": "object",
"properties": {
"weekId": {
"type": "integer",
"format": "int32"
},
"weekendBill": {
"type": "string"
},
"isOpen": {
"type": "boolean"
},
"weekStatus": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.WeekendDateList.Result": {
"type": "object",
"properties": {
"weekendDate": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.WorkerCompCodeListQuery.Result": {
"type": "object",
"properties": {
"workerCompCodeId": {
"type": "integer",
"format": "int32"
},
"workerCompCode": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"percentage": {
"type": "number",
"format": "double"
},
"overtimeCalcType": {
"type": "string",
"nullable": true
},
"stateLAndIEmployee": {
"type": "number",
"format": "double"
},
"stateLAndIEmployer": {
"type": "number",
"format": "double"
},
"region": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Datalists.WotcEligibilityStatusList.Result": {
"type": "object",
"properties": {
"wotcEligibilityStatusId": {
"type": "integer",
"format": "int64"
},
"wotcEligibilityStatus": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Documents.DocumentMetadataQuery.Metadata": {
"type": "object",
"properties": {
"maximumFileUploadSize": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Documents.DocumentMetadataQuery.Query": {
"type": "object",
"additionalProperties": false
},
"TwApi.Shared.Commands.Documents.GetEntityDocumentQuery.Document": {
"type": "object",
"properties": {
"documentId": {
"type": "integer",
"format": "int32"
},
"ownerOriginId": {
"type": "integer",
"format": "int64"
},
"ownerOriginType": {
"$ref": "#/components/schemas/TwApi.Common.Enums.OriginType"
},
"documentDate": {
"type": "string",
"format": "date-time"
},
"description": {
"type": "string",
"nullable": true
},
"fileType": {
"type": "string",
"nullable": true
},
"documentTypeId": {
"type": "integer",
"format": "int32"
},
"documentType": {
"type": "string",
"nullable": true
},
"documentName": {
"type": "string",
"nullable": true
},
"fileName": {
"type": "string",
"nullable": true
},
"expirationDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"documentVersion": {
"type": "string",
"nullable": true
},
"fileSize": {
"type": "integer",
"format": "int64",
"nullable": true
},
"canBeDeleted": {
"type": "boolean"
},
"canBeEdited": {
"type": "boolean"
},
"documentRootGuid": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Documents.GetEntityDocumentsQuery.Result": {
"type": "object",
"properties": {
"documentId": {
"type": "integer",
"format": "int32"
},
"documentDate": {
"type": "string",
"format": "date-time"
},
"description": {
"type": "string",
"nullable": true
},
"fileType": {
"type": "string",
"nullable": true
},
"fileSize": {
"type": "integer",
"format": "int64",
"nullable": true
},
"documentTypeId": {
"type": "integer",
"format": "int32"
},
"documentType": {
"type": "string",
"nullable": true
},
"documentName": {
"type": "string",
"nullable": true
},
"fileName": {
"type": "string",
"nullable": true
},
"expirationDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"documentVersion": {
"type": "string",
"nullable": true
},
"canBeDeleted": {
"type": "boolean"
},
"canBeEdited": {
"type": "boolean"
},
"uploadedToSovren": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Documents.UploadEntityDocumentCommand.Result": {
"type": "object",
"properties": {
"documentId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Invite.GenerateInviteCode.Result": {
"type": "object",
"properties": {
"inviteCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Reports.SpecialReportDetails.Result": {
"type": "object",
"properties": {
"specialReportId": {
"type": "string",
"format": "uuid"
},
"reportName": {
"type": "string",
"nullable": true
},
"reportPath": {
"type": "string",
"nullable": true
},
"productId": {
"$ref": "#/components/schemas/TwApi.Common.Enums.Products"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.StatusChange.Models.PrerequisiteValidationResult": {
"type": "object",
"properties": {
"ruleId": {
"type": "integer",
"format": "int64"
},
"ruleName": {
"type": "string",
"nullable": true
},
"target": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.StatusChange.Models.RuleTarget"
},
"isRequired": {
"type": "boolean"
},
"validationMessage": {
"type": "string",
"nullable": true
},
"isValid": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.StatusChange.Models.RuleTarget": {
"type": "object",
"properties": {
"ruleTargetId": {
"type": "string",
"nullable": true
},
"resourceLocation": {
"type": "string",
"nullable": true
},
"originTypeId": {
"type": "integer",
"format": "int32"
},
"originId": {
"type": "integer",
"format": "int64"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.StatusChange.OriginStatusChangeMetadataQuery.Result": {
"type": "object",
"properties": {
"statusChangeIsValid": {
"type": "boolean",
"readOnly": true
},
"validationResults": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.StatusChange.OriginStatusChangeMetadataQuery.Result.ValidationResult"
},
"nullable": true,
"readOnly": true
},
"prerequisites": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.StatusChange.Models.PrerequisiteValidationResult"
},
"nullable": true
},
"defaultMessage": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.StatusChange.OriginStatusChangeMetadataQuery.Result.MessageDefaults"
},
"defaultTask": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.StatusChange.OriginStatusChangeMetadataQuery.Result.TaskDefaults"
},
"additionalActions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.StatusChange.OriginStatusChangeMetadataQuery.Result.AdditionalActionOnChange"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.StatusChange.OriginStatusChangeMetadataQuery.Result.AdditionalActionOnChange": {
"type": "object",
"properties": {
"additionalActionId": {
"type": "integer",
"format": "int64"
},
"additionalActionDescription": {
"type": "string",
"nullable": true
},
"additionalActionName": {
"type": "string",
"nullable": true
},
"alwaysExecuteAction": {
"type": "boolean"
},
"executeActionDefault": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.StatusChange.OriginStatusChangeMetadataQuery.Result.MessageDefaults": {
"type": "object",
"properties": {
"message": {
"type": "string",
"nullable": true
},
"actionId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"isMessageRequired": {
"type": "boolean"
},
"isMessageEditAllowed": {
"type": "boolean"
},
"createMessage": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.StatusChange.OriginStatusChangeMetadataQuery.Result.TaskDefaults": {
"type": "object",
"properties": {
"subject": {
"type": "string",
"nullable": true
},
"notes": {
"type": "string",
"nullable": true
},
"priority": {
"type": "integer",
"format": "int64",
"nullable": true
},
"dateDue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"assignedToServiceRepId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"teamId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"isPrivate": {
"type": "boolean",
"nullable": true
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"isTaskRequired": {
"type": "boolean"
},
"isTaskEditAllowed": {
"type": "boolean"
},
"createTask": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.StatusChange.OriginStatusChangeMetadataQuery.Result.ValidationResult": {
"type": "object",
"properties": {
"validationMessage": {
"type": "string",
"nullable": true
},
"isValid": {
"type": "boolean"
},
"propertyName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Tasks.CreateEntityTaskMessageCommand.Command": {
"required": [
"message"
],
"type": "object",
"properties": {
"apiUser": {
"$ref": "#/components/schemas/TwApi.Common.Models.ApiUser"
},
"taskId": {
"type": "string",
"format": "uuid"
},
"originTypeId": {
"type": "integer",
"format": "int32"
},
"originId": {
"type": "integer",
"format": "int64"
},
"actionId": {
"type": "integer",
"format": "int32"
},
"message": {
"minLength": 1,
"type": "string"
},
"shouldLinkOriginsOneByOne": {
"type": "boolean"
},
"shouldLinkRelatedEntities": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Tasks.CreateTaskCommand.Result": {
"type": "object",
"properties": {
"taskId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Tasks.TaskDetailsQuery.Result": {
"type": "object",
"properties": {
"taskId": {
"type": "string",
"format": "uuid"
},
"subject": {
"type": "string",
"nullable": true
},
"notes": {
"type": "string",
"nullable": true
},
"priority": {
"type": "integer",
"format": "int64"
},
"dateDue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"linkedToOriginId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"linkedToOrigin": {
"type": "string",
"nullable": true
},
"linkedToOriginTypeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"linkedToOriginType": {
"type": "string",
"nullable": true
},
"assignedToServiceRepId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"assignedToServiceRep": {
"type": "string",
"nullable": true
},
"teamId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"team": {
"type": "string",
"nullable": true
},
"isPinned": {
"type": "boolean"
},
"isPrivate": {
"type": "boolean"
},
"dateCreated": {
"type": "string",
"format": "date-time"
},
"dateArchived": {
"type": "string",
"format": "date-time",
"nullable": true
},
"isArchived": {
"type": "boolean"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Tasks.TaskListQuery.Result": {
"type": "object",
"properties": {
"taskId": {
"type": "string",
"format": "uuid"
},
"subject": {
"type": "string",
"nullable": true
},
"notes": {
"type": "string",
"nullable": true
},
"priority": {
"type": "integer",
"format": "int64"
},
"dateDue": {
"type": "string",
"format": "date-time",
"nullable": true
},
"linkedToOriginId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"linkedToOrigin": {
"type": "string",
"nullable": true
},
"linkedToOriginTypeId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"linkedToOriginType": {
"type": "string",
"nullable": true
},
"assignedToServiceRepId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"assignedToServiceRep": {
"type": "string",
"nullable": true
},
"teamId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"team": {
"type": "string",
"nullable": true
},
"createdByServiceRepId": {
"type": "integer",
"format": "int32"
},
"createdByServiceRep": {
"type": "string",
"nullable": true
},
"isPinned": {
"type": "boolean"
},
"isPrivate": {
"type": "boolean"
},
"dateCreated": {
"type": "string",
"format": "date-time"
},
"dateArchived": {
"type": "string",
"format": "date-time",
"nullable": true
},
"isArchived": {
"type": "boolean"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Timeclock.CreateEntityPunchLocation.Result": {
"type": "object",
"properties": {
"punchLocationId": {
"type": "integer",
"format": "int64"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Timeclock.CustomerTimeclockCostCodeList.Result": {
"type": "object",
"properties": {
"costCode": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Timeclock.CustomerTimeclockPayCodeList.Result": {
"type": "object",
"properties": {
"payCodeId": {
"type": "integer",
"format": "int32"
},
"payCode": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"isDefault": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Timeclock.PunchLocationList.Result": {
"type": "object",
"properties": {
"punchLocationId": {
"type": "integer",
"format": "int64"
},
"punchLocation": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"latitude": {
"type": "number",
"format": "double"
},
"longitude": {
"type": "number",
"format": "double"
},
"radius": {
"type": "number",
"format": "double"
},
"radiusDistanceUnitId": {
"type": "integer",
"format": "int64"
},
"radiusDistanceUnit": {
"type": "string",
"nullable": true
},
"radiusDistanceUnitsPerMeter": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Users.UserCachedFlattenedFeatures.Result": {
"type": "object",
"properties": {
"isAssessOnCloudEnabled": {
"type": "boolean"
},
"isHrCenterEnabled": {
"type": "boolean"
},
"isWebCenterEnabled": {
"type": "boolean"
},
"isEverifyEnabled": {
"type": "boolean"
},
"isPayrollEnabled": {
"type": "boolean"
},
"isTextMessageIntegrationEnabled": {
"type": "boolean"
},
"isCompanionEnabled": {
"type": "boolean"
},
"isCompanionTimeEntryEnabled": {
"type": "boolean"
},
"isCompanionTimeClockEnabled": {
"type": "boolean"
},
"isCompanionChatEnabled": {
"type": "boolean"
},
"isCompanionOrderDistributionEnabled": {
"type": "boolean"
},
"isTempworksMobileAppEnabled": {
"type": "boolean"
},
"isTempworksMobileAppPunchEnabled": {
"type": "boolean"
},
"isBeyondEnabled": {
"type": "boolean"
},
"isFirstAdvantageBackgroundCheckEnabled": {
"type": "boolean"
},
"isTextMessagingIntegrationEnabled": {
"type": "boolean"
},
"isAsurintBackgroundCheckEnabled": {
"type": "boolean"
},
"isCiaBackgroundCheckEnabled": {
"type": "boolean"
},
"isCrimcheckBackgroundCheckEnabled": {
"type": "boolean"
},
"isUniversalBackgroundCheckEnabled": {
"type": "boolean"
},
"isSourceDirectBackgroundCheckEnabled": {
"type": "boolean"
},
"isCentralizedAggregatorServiceOrganizationManagementEnabled": {
"type": "boolean"
},
"isShlAssessmentsEnabled": {
"type": "boolean"
},
"isSovrenMatchingEnabled": {
"type": "boolean"
},
"isSovrenSourcingEnabled": {
"type": "boolean"
},
"isOnSiteTimeClockEnabled": {
"type": "boolean"
},
"isCentralizedOrganizationManagementEnabled": {
"type": "boolean"
},
"isSSOAuthenticationEnabled": {
"type": "boolean"
},
"isRapidPaycardEnrollmentAndInstantFundingEnabled": {
"type": "boolean"
},
"isSystemIQEnabled": {
"type": "boolean"
},
"isLlhEnabled": {
"type": "boolean"
},
"isOnboarding2Enabled": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Users.UserCachedPermissionsQuery.Result": {
"type": "object",
"properties": {
"permissions": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Users.UserLicense.Result": {
"type": "object",
"properties": {
"expirationDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"doNotExpire": {
"type": "boolean"
},
"warnPriorToExpiration": {
"type": "boolean"
},
"isHosted": {
"type": "boolean"
},
"userCount": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.Utilities.CalculateMarkupsCommand.ChangedValue": {
"enum": [
1,
2,
3,
4,
5
],
"type": "integer",
"format": "int32"
},
"TwApi.Shared.Commands.Utilities.CalculateMarkupsCommand.Result": {
"type": "object",
"properties": {
"payRate": {
"type": "number",
"format": "double"
},
"overtimePayRate": {
"type": "number",
"format": "double"
},
"doubletimePayRate": {
"type": "number",
"format": "double"
},
"billRate": {
"type": "number",
"format": "double"
},
"overtimeBillRate": {
"type": "number",
"format": "double"
},
"doubletimeBillRate": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.WebUserAccounts.CreateWebUserAccount.Result": {
"type": "object",
"properties": {
"webUserId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.WebUserAccounts.CreateWebUserAccountRegistrationLink.Result": {
"required": [
"expiration",
"registrationLink"
],
"type": "object",
"properties": {
"registrationLink": {
"type": "string",
"nullable": true
},
"expiration": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.WebUserAccounts.GetDefaultProductInstancesForOriginTypeQuery.Result": {
"type": "object",
"properties": {
"webCenterProductInstanceId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"webCenterRoleId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"hrCenterProductInstanceId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"companionProductInstanceId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"jobBoardProductInstanceId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"tempWorksMobileAppProductInstanceId": {
"type": "string",
"format": "uuid",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.WebUserAccounts.GetOriginInfoForWebUserQuery.Result": {
"type": "object",
"properties": {
"originTypeId": {
"type": "integer",
"format": "int32"
},
"originId": {
"type": "integer",
"format": "int64"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.WebUserAccounts.GetWebUserAccountDetails.ProductInstance": {
"type": "object",
"properties": {
"productInstanceId": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string",
"nullable": true
},
"isDeprecated": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.WebUserAccounts.GetWebUserAccountDetails.Result": {
"type": "object",
"properties": {
"webUserAccountId": {
"type": "string",
"format": "uuid"
},
"username": {
"type": "string",
"nullable": true
},
"dateCreated": {
"type": "string",
"format": "date-time"
},
"dateLastLoggedIn": {
"type": "string",
"format": "date-time",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"requiresPasswordReset": {
"type": "boolean"
},
"hrCenterProductInstances": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Shared.Commands.WebUserAccounts.GetWebUserAccountDetails.ProductInstance"
},
"nullable": true
},
"webCenterProductInstanceId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"webCenterProductInstance": {
"type": "string",
"nullable": true
},
"webCenterProductInstanceIsDeprecated": {
"type": "boolean",
"nullable": true
},
"webCenterRoleId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"webCenterRole": {
"type": "string",
"nullable": true
},
"companionProductInstanceId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"companionProductInstance": {
"type": "string",
"nullable": true
},
"companionProductInstanceIsDeprecated": {
"type": "boolean",
"nullable": true
},
"jobBoardProductInstanceId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"jobBoardProductInstance": {
"type": "string",
"nullable": true
},
"jobBoardProductInstanceIsDeprecated": {
"type": "boolean",
"nullable": true
},
"tempWorksMobileAppProductInstanceId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"tempWorksMobileAppProductInstance": {
"type": "string",
"nullable": true
},
"tempWorksMobileAppProductInstanceIsDeprecated": {
"type": "boolean",
"nullable": true
},
"isLocked": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.WebUserAccounts.GetWebUserDocumentTypes.Result": {
"type": "object",
"properties": {
"documentTypeId": {
"type": "integer",
"format": "int32"
},
"documentDescription": {
"type": "string",
"nullable": true
},
"isResume": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.WebUserAccounts.GetWebUserDocuments.Result": {
"type": "object",
"properties": {
"documentId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"lastModified": {
"type": "string",
"format": "date-time",
"nullable": true
},
"reportGroup": {
"type": "string",
"nullable": true
},
"fileType": {
"type": "string",
"nullable": true
},
"fileTypeDescription": {
"type": "string",
"nullable": true
},
"urlPath": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.WebUserAccounts.GetWebUserUploadedDocuments.Result": {
"type": "object",
"properties": {
"documentId": {
"type": "integer",
"format": "int32"
},
"documentName": {
"type": "string",
"nullable": true
},
"lastModified": {
"type": "string",
"format": "date-time",
"nullable": true
},
"documentDescription": {
"type": "string",
"nullable": true
},
"fileType": {
"type": "string",
"nullable": true
},
"documentTypeDescription": {
"type": "string",
"nullable": true
},
"isResume": {
"type": "boolean",
"nullable": true
},
"allowDelete": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.WebUserAccounts.WebCenterRoleList.Result": {
"type": "object",
"properties": {
"webCenterRoleId": {
"type": "string",
"format": "uuid"
},
"webCenterRole": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
},
"isProductInstanceDefault": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.WebUserAccounts.WebUserAccountDetailsByEntity.Result": {
"type": "object",
"properties": {
"webUserAccountId": {
"type": "string",
"format": "uuid"
},
"username": {
"type": "string",
"nullable": true
},
"dateCreated": {
"type": "string",
"format": "date-time"
},
"dateLastLoggedIn": {
"type": "string",
"format": "date-time",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"requiresPasswordReset": {
"type": "boolean"
},
"hrCenterProductInstanceId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"hrCenterProductInstance": {
"type": "string",
"nullable": true
},
"hrCenterProductInstanceIsDeprecated": {
"type": "boolean",
"nullable": true
},
"webCenterProductInstanceId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"webCenterProductInstance": {
"type": "string",
"nullable": true
},
"webCenterProductInstanceIsDeprecated": {
"type": "boolean",
"nullable": true
},
"webCenterRoleId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"webCenterRole": {
"type": "string",
"nullable": true
},
"companionProductInstanceId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"companionProductInstance": {
"type": "string",
"nullable": true
},
"companionProductInstanceIsDeprecated": {
"type": "boolean",
"nullable": true
},
"jobBoardProductInstanceId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"jobBoardProductInstance": {
"type": "string",
"nullable": true
},
"jobBoardProductInstanceIsDeprecated": {
"type": "boolean",
"nullable": true
},
"tempWorksMobileAppProductInstanceId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"tempWorksMobileAppProductInstance": {
"type": "string",
"nullable": true
},
"tempWorksMobileAppProductInstanceIsDeprecated": {
"type": "boolean",
"nullable": true
},
"isLocked": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.WebUserAccounts.WebUserAccountProductInstanceListByOriginPairQuery.Result": {
"type": "object",
"properties": {
"productInstanceId": {
"type": "string",
"format": "uuid"
},
"productId": {
"$ref": "#/components/schemas/TwApi.Common.Enums.Products"
},
"product": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"productLastLogin": {
"type": "string",
"format": "date-time",
"nullable": true
},
"isDeprecated": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Shared.Commands.WebUserAccounts.WebUserAvailableProductInstances.Result": {
"type": "object",
"properties": {
"productInstanceId": {
"type": "string",
"format": "uuid"
},
"productId": {
"$ref": "#/components/schemas/TwApi.Common.Enums.Products"
},
"product": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"isDeprecated": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestAnalytics": {
"type": "object",
"properties": {
"ip": {
"type": "string",
"nullable": true
},
"referrer": {
"type": "string",
"nullable": true
},
"userAgent": {
"type": "string",
"nullable": true
},
"targetedApplyAd": {
"type": "boolean"
},
"sponsored": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestJob": {
"type": "object",
"properties": {
"jobCompany": {
"type": "string",
"nullable": true
},
"jobId": {
"type": "string",
"nullable": true
},
"jobLocation": {
"type": "string",
"nullable": true
},
"jobMeta": {
"type": "string",
"nullable": true
},
"jobTitle": {
"type": "string",
"nullable": true
},
"jobUrl": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume": {
"type": "object",
"properties": {
"file": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeFile"
},
"text": {
"type": "string",
"nullable": true
},
"html": {
"type": "string",
"nullable": true
},
"json": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicant"
}
},
"additionalProperties": false
},
"TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicant": {
"type": "object",
"properties": {
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"headline": {
"type": "string",
"nullable": true
},
"summary": {
"type": "string",
"nullable": true
},
"publicProfileUrl": {
"type": "string",
"nullable": true
},
"additionalInfo": {
"type": "string",
"nullable": true
},
"phoneNumber": {
"type": "string",
"nullable": true
},
"location": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantLocation"
},
"skills": {
"type": "string",
"nullable": true
},
"positions": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantResults`1[[TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantPosition, Vendors.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
},
"educations": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantResults`1[[TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantEducation, Vendors.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
},
"links": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantResults`1[[TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantLink, Vendors.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
},
"awards": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantResults`1[[TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantAward, Vendors.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
},
"certifications": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantResults`1[[TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantCertification, Vendors.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
},
"associations": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantResults`1[[TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantAssociation, Vendors.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
},
"patents": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantResults`1[[TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantPatent, Vendors.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
},
"publications": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantResults`1[[TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantPublication, Vendors.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
},
"militaryServices": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantResults`1[[TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantMilitaryService, Vendors.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"additionalProperties": false
},
"TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantAssociation": {
"type": "object",
"properties": {
"title": {
"type": "string",
"nullable": true
},
"startDateMonth": {
"type": "string",
"nullable": true
},
"startDateYear": {
"type": "string",
"nullable": true
},
"endDateMonth": {
"type": "string",
"nullable": true
},
"endDateYear": {
"type": "string",
"nullable": true
},
"endCurrent": {
"type": "boolean"
},
"description": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantAward": {
"type": "object",
"properties": {
"title": {
"type": "string",
"nullable": true
},
"dateMonth": {
"type": "string",
"nullable": true
},
"dateYear": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantCertification": {
"type": "object",
"properties": {
"title": {
"type": "string",
"nullable": true
},
"startDateMonth": {
"type": "string",
"nullable": true
},
"startDateYear": {
"type": "string",
"nullable": true
},
"endDateMonth": {
"type": "string",
"nullable": true
},
"endDateYear": {
"type": "string",
"nullable": true
},
"endCurrent": {
"type": "boolean"
},
"description": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantEducation": {
"type": "object",
"properties": {
"degree": {
"type": "string",
"nullable": true
},
"field": {
"type": "string",
"nullable": true
},
"school": {
"type": "string",
"nullable": true
},
"location": {
"type": "string",
"nullable": true
},
"startDateYear": {
"type": "string",
"nullable": true
},
"endDateYear": {
"type": "string",
"nullable": true
},
"endCurrent": {
"type": "boolean"
}
},
"additionalProperties": false
},
"TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantLink": {
"type": "object",
"properties": {
"url": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantLocation": {
"type": "object",
"properties": {
"city": {
"type": "string",
"nullable": true
},
"country": {
"type": "string",
"nullable": true
},
"postalCode": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantMilitaryService": {
"type": "object",
"properties": {
"serviceBranch": {
"type": "string",
"nullable": true
},
"branch": {
"type": "string",
"nullable": true
},
"rank": {
"type": "string",
"nullable": true
},
"startDateMonth": {
"type": "string",
"nullable": true
},
"startDateYear": {
"type": "string",
"nullable": true
},
"endDateMonth": {
"type": "string",
"nullable": true
},
"endDateYear": {
"type": "string",
"nullable": true
},
"endCurrent": {
"type": "boolean"
},
"commendations": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantPatent": {
"type": "object",
"properties": {
"patentNumber": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"url": {
"type": "string",
"nullable": true
},
"dateMonth": {
"type": "string",
"nullable": true
},
"dateYear": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantPosition": {
"type": "object",
"properties": {
"title": {
"type": "string",
"nullable": true
},
"company": {
"type": "string",
"nullable": true
},
"location": {
"type": "string",
"nullable": true
},
"startDateMonth": {
"type": "string",
"nullable": true
},
"startDateYear": {
"type": "string",
"nullable": true
},
"endDateMonth": {
"type": "string",
"nullable": true
},
"endDateYear": {
"type": "string",
"nullable": true
},
"endCurrent": {
"type": "boolean"
},
"description": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantPublication": {
"type": "object",
"properties": {
"title": {
"type": "string",
"nullable": true
},
"url": {
"type": "string",
"nullable": true
},
"dateDay": {
"type": "string",
"nullable": true
},
"dateMonth": {
"type": "string",
"nullable": true
},
"dateYear": {
"type": "string",
"nullable": true
},
"description": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantResults`1[[TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantAssociation, Vendors.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"_total": {
"type": "integer",
"format": "int32"
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantAssociation"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantResults`1[[TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantAward, Vendors.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"_total": {
"type": "integer",
"format": "int32"
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantAward"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantResults`1[[TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantCertification, Vendors.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"_total": {
"type": "integer",
"format": "int32"
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantCertification"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantResults`1[[TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantEducation, Vendors.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"_total": {
"type": "integer",
"format": "int32"
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantEducation"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantResults`1[[TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantLink, Vendors.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"_total": {
"type": "integer",
"format": "int32"
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantLink"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantResults`1[[TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantMilitaryService, Vendors.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"_total": {
"type": "integer",
"format": "int32"
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantMilitaryService"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantResults`1[[TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantPatent, Vendors.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"_total": {
"type": "integer",
"format": "int32"
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantPatent"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantResults`1[[TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantPosition, Vendors.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"_total": {
"type": "integer",
"format": "int32"
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantPosition"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantResults`1[[TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantPublication, Vendors.Service, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"_total": {
"type": "integer",
"format": "int32"
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeApplicantPublication"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Vendors.Service.Commands.Indeed.Models.IndeedApplyIngestResume.ResumeFile": {
"type": "object",
"properties": {
"contentType": {
"type": "string",
"nullable": true
},
"data": {
"type": "string",
"nullable": true
},
"fileName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Vendors.Service.Commands.Sense.GetSenseOriginSyncInfo.Result": {
"type": "object",
"properties": {
"hasSynced": {
"type": "boolean"
},
"syncHistoryId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"lastSyncDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"lastSyncFailed": {
"type": "boolean",
"nullable": true
},
"lastSyncFailureMessage": {
"type": "string",
"nullable": true
},
"canSyncSenseData": {
"type": "boolean"
},
"cannotSyncSenseDataReasons": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Vendors.Service.Commands.Sense.GetSenseSyncSystemInfo.Result": {
"type": "object",
"properties": {
"isCurrentlyRunning": {
"type": "boolean",
"nullable": true
},
"lastSyncFailed": {
"type": "boolean",
"nullable": true
},
"lastSyncCompletedDate": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"TwApi.Vendors.Service.Commands.Sovren.Commands.GenerateMatchForEmployee.Result": {
"type": "object",
"properties": {
"matchUrl": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Vendors.Service.Commands.Sovren.Commands.GenerateMatchForJobOrder.Result": {
"type": "object",
"properties": {
"matchUrl": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Vendors.Service.Commands.Sovren.Commands.GenerateSearch.Result": {
"type": "object",
"properties": {
"searchUrl": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Vendors.Service.Commands.Sovren.ImportSovrenSourcedResume.Result": {
"type": "object",
"properties": {
"target": {
"type": "string",
"nullable": true
},
"targetOrigin": {
"type": "string",
"nullable": true
},
"data": {
"$ref": "#/components/schemas/TwApi.Vendors.Service.Commands.Sovren.Models.SovrenHookData"
}
},
"additionalProperties": false
},
"TwApi.Vendors.Service.Commands.Sovren.Models.SovrenHookData": {
"type": "object",
"properties": {
"employeeId": {
"type": "string",
"nullable": true
},
"errorMessage": {
"type": "string",
"nullable": true
},
"hookType": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Vendors.Service.Commands.Sovren.Models.SovrenUserJobBoardDetail": {
"type": "object",
"properties": {
"canEdit": {
"type": "boolean"
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"serviceRepId": {
"type": "integer",
"format": "int64",
"nullable": true
},
"jobBoardName": {
"type": "string",
"nullable": true
},
"username": {
"type": "string",
"nullable": true
},
"password": {
"type": "string",
"nullable": true
},
"companyId": {
"type": "string",
"nullable": true
},
"apiKey": {
"type": "string",
"nullable": true
},
"isActive": {
"type": "boolean"
},
"statusId": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"TwApi.Vendors.Service.Commands.Sovren.Queries.GetConsentToUpload.Result": {
"type": "object",
"properties": {
"hasConsentToUpload": {
"type": "boolean"
},
"consentToUploadDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"consentToUploadServiceRepId": {
"type": "integer",
"format": "int32",
"nullable": true
},
"consentToUploadServiceRep": {
"type": "string",
"nullable": true
},
"isUploadComplete": {
"type": "boolean"
},
"hasAggregatorBeenSetupForTenant": {
"type": "boolean"
},
"doesTenantHaveADefaultServiceRep": {
"type": "boolean"
},
"unableToConsentReason": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Vendors.Service.Commands.Sovren.Queries.GetSovrenEmployeeMetadata.Result": {
"type": "object",
"properties": {
"canPerformMatching": {
"type": "boolean"
},
"cannotPerformMatchingReason": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Vendors.Service.Commands.Sovren.Queries.GetSovrenJobBoardAccount.Result": {
"type": "object",
"properties": {
"serviceRepId": {
"type": "integer",
"format": "int32"
},
"jobBoardName": {
"type": "string",
"nullable": true
},
"username": {
"type": "string",
"nullable": true
},
"password": {
"type": "string",
"nullable": true
},
"companyId": {
"type": "string",
"nullable": true
},
"apiKey": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Vendors.Service.Commands.Sovren.Queries.GetSovrenJobOrderMetadata.Result": {
"type": "object",
"properties": {
"canPerformMatching": {
"type": "boolean"
},
"cannotPerformMatchingReason": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"TwApi.Vendors.Service.Commands.Sovren.Queries.GetSovrenSearchMetadata.Result": {
"type": "object",
"properties": {
"canPerformMatching": {
"type": "boolean"
},
"cannotPerformMatchingReason": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
},
"securitySchemes": {
"Bearer": {
"type": "apiKey",
"description": "Authenticate using authorization header. Basic and Bearer with reference token supported.
Bearer Example: Bearer e9181d285be74803b5c8a30a64e1e067
Basic Example: Basic lkajsdlkjalsdkjf=",
"name": "Authorization",
"in": "header"
},
"x-tw-token": {
"type": "apiKey",
"description": "Please insert Personal Access Token",
"name": "x-tw-token",
"in": "header"
}
}
},
"security": [
{
"Bearer": [ ]
},
{
"x-tw-token": [ ]
}
]
}