Public
Documentation Settings
No Environment
Double Column
cURL - cURL
Employee_9.8
Introduction
GET
Get Employee
POST
Post Employee
PUT
Put Employee
DEL
Delete Employee
POST
Query by ID
POST
Query Employee By Number

Employee_9.8

GETGet Employee

https://am-ce98c.corrigo.com/api/v1/base/Employee/15
AUTHORIZATIONOAuth 2.0
HEADERS
CompanyName

RDC CE Sandbox

Example Request
Get Employee
curl
curl --location 'https://am-ce98c.corrigo.com/api/v1/base/Employee/15' \
--header 'CompanyName: RDC CE Sandbox'
200 OK
Example Response
json
{
  "Data": {
    "FirstName": "",
    "LastName": "",
    "DisplayAs": "SIERRA FIRE & COMMUNICATIONS (deleted)",
    "AccessToAllWorkZones": false,
    "LanguageId": 1033,
    "ActorTypeId": "Provider",
    "Username": "a599d28c-c9d3-4bf7-8670-b3ff11c59c03",
    "DtPwdChange": "1753-01-01T00:00:00",
    "Instructions": "suspended per Abigail Hamrick.  12/27/16",
    "WonMemberId": 0,
    "WonLocationId": 0,
    "WonServiceRadius": 0,
    "IsElectronicPayment": false,
    "ProviderStatusId": "NA",
    "LabelId": 0,
    "FreeTextAllowed": false,
    "RadiusUnit": "Mile",
    "Password": "",
    "Number": "",
    "JobTitle": "",
    "FederalId": "",
    "ExternalId": "",
    "ForcePasswordReset": false,
    "TaxWarnOnly": false,
    "BillAtZero": false,
    "IsSupplier": false,
    "ProviderTypeId": "Regular",
    "TaxExempt": false,
    "LimitAssignmentByPortfolioId": 0,
    "IsRemoved": true,
    "ConcurrencyId": 15,
    "Id": 15
  }
}
Cache-Control

no-cache

Pragma

no-cache

Content-Type

application/json; charset=utf-8

Expires

-1

Date

Tue, 08 Mar 2022 07:13:48 GMT

Content-Length

754

Strict-Transport-Security

max-age=31536000; includeSubDomains

POSTPost Employee

https://am-ce98c.corrigo.com/api/v1/base/Employee
AUTHORIZATIONOAuth 2.0
Access Token

<access-token>

HEADERS
CompanyName

RDC CE Sandbox

Bodyraw (json)
json
{
 "Entity": {
    "FirstName": "Erik",
        "LastName": "Blomberg",
        "DisplayAs": "1Blomberg, Erik",
        "Role":{ "Id":1},
        "AccessToAllWorkZones": false,
        "LanguageId": 1033,
        "ActorTypeId": "Employee",
        "Username": "177ce294-8d83-4d23-af03-e7cab6caa33eee",
        "DtPwdChange": "2016-07-11T00:00:00",
        "Instructions": "2",
        "WonMemberId": 0,
        "WonLocationId": 0,
        "WonServiceRadius": 0,
        "IsElectronicPayment": false,
        "ProviderStatusId": "NA",
        "LabelId": 0,
        "FreeTextAllowed": true,
        "RadiusUnit": "Mile",
        "Password": "Password@123",
        "Number": "511",
        "JobTitle": "test",
        "FederalId": "",
        "ExternalId": "",
        "ForcePasswordReset": false,
        "TaxWarnOnly": false,
        "PriceLists": [],
        "CustomFields": [],
        "BillAtZero": false,
        "IsSupplier": false,
        "ProviderTypeId": "Regular",
        "ContactAddresses": [],
        "Teams": [],
        "WorkZones": [],
        "Portfolios": [],
        "CustomerGroups": [],
        "Specialties": [],
        "PayRates": [],
        "StockLocations": [],
        "Services": [],
        "AlertSubscriptions": [],
        "TaxExempt": false,
        "LimitAssignmentByPortfolioId": 0,
        "IsRemoved": true,
        "ConcurrencyId": 4,
        "Id": 5,     
        "PerformDeletion": false,
        "IsNew": true
    }
}
Example Request
Post Employee
curl
curl --location 'https://am-ce98c.corrigo.com/api/v1/base/Employee' \
--header 'CompanyName: RDC CE Sandbox' \
--data-raw '{
 "Entity": {
    "FirstName": "Erik",
        "LastName": "Blomberg",
        "DisplayAs": "1Blomberg, Erik",
        "Role":{ "Id":1},
        "AccessToAllWorkZones": false,
        "LanguageId": 1033,
        "ActorTypeId": "Employee",
        "Username": "177ce294-8d83-4d23-af03-e7cab6caa33eee",
        "DtPwdChange": "2016-07-11T00:00:00",
        "Instructions": "2",
        "WonMemberId": 0,
        "WonLocationId": 0,
        "WonServiceRadius": 0,
        "IsElectronicPayment": false,
        "ProviderStatusId": "NA",
        "LabelId": 0,
        "FreeTextAllowed": true,
        "RadiusUnit": "Mile",
        "Password": "Password@123",
        "Number": "511",
        "JobTitle": "test",
        "FederalId": "",
        "ExternalId": "",
        "ForcePasswordReset": false,
        "TaxWarnOnly": false,
        "PriceLists": [],
        "CustomFields": [],
        "BillAtZero": false,
        "IsSupplier": false,
        "ProviderTypeId": "Regular",
        "ContactAddresses": [],
        "Teams": [],
        "WorkZones": [],
        "Portfolios": [],
        "CustomerGroups": [],
        "Specialties": [],
        "PayRates": [],
        "StockLocations": [],
        "Services": [],
        "AlertSubscriptions": [],
        "TaxExempt": false,
        "LimitAssignmentByPortfolioId": 0,
        "IsRemoved": true,
        "ConcurrencyId": 4,
        "Id": 5,     
        "PerformDeletion": false,
        "IsNew": true
    }
}'
200 OK
Example Response
json
{
  "EntitySpecifier": {
    "ConcurrencyId": 1,
    "EntityType": "Employee",
    "Id": 622
  }
}
Cache-Control

no-cache

Pragma

no-cache

Content-Type

application/json; charset=utf-8

Expires

-1

Date

Tue, 08 Mar 2022 07:14:30 GMT

Content-Length

72

Strict-Transport-Security

max-age=31536000; includeSubDomains

PUTPut Employee

https://am-ce98c.corrigo.com/api/v1/base/Employee
AUTHORIZATIONOAuth 2.0
HEADERS
CompanyName

RDC CE Sandbox

Bodyraw (json)
json
{
                "Properties" : ["*"] ,
                "Entity":
                {
        "FirstName": "Erik",
        "LastName": "Blomberg",
        "DisplayAs": "1Blomberg, Erik",
        "Role":{ "Id":1},
        "AccessToAllWorkZones": false,
        "LanguageId": 1033,
        "ActorTypeId": "Employee",
        "Username": "177ce294-8d83-4d23-af03-e7cab6caa33d",
        "DtPwdChange": "2016-07-11T00:00:00",
        "Instructions": "2",
        "WonMemberId": 0,
        "WonLocationId": 0,
        "WonServiceRadius": 0,
        "IsElectronicPayment": false,
        "ProviderStatusId": "NA",
        "LabelId": 0,
        "FreeTextAllowed": true,
        "RadiusUnit": "Mile",
        "Password": "Password@12345",
        "Number": "123",
        "JobTitle": "test",
        "FederalId": "",
        "ExternalId": "",
        "ForcePasswordReset": false,
        "TaxWarnOnly": false,
        "PriceLists": [],
        "CustomFields": [],
        "BillAtZero": false,
        "IsSupplier": false,
        "ProviderTypeId": "Regular",
        "ContactAddresses": [],
        "Teams": [],
        "WorkZones": [],
        "Portfolios": [],
        "CustomerGroups": [],
        "Specialties": [],
        "PayRates": [],
        "StockLocations": [],
        "Services": [],
        "AlertSubscriptions": [],
        "TaxExempt": false,
        "LimitAssignmentByPortfolioId": 0,
        "IsRemoved": true,
        "ConcurrencyId": 4,
        "Id": 5,
        "PerformDeletion": false,
        "IsNew": true
    }
}
Example Request
Put Employee
curl
curl --location --request PUT 'https://am-ce98c.corrigo.com/api/v1/base/Employee' \
--header 'CompanyName: RDC CE Sandbox' \
--data-raw '{
                "Properties" : ["*"] ,
                "Entity":
                {
        "FirstName": "Erik",
        "LastName": "Blomberg",
        "DisplayAs": "1Blomberg, Erik",
        "Role":{ "Id":1},
        "AccessToAllWorkZones": false,
        "LanguageId": 1033,
        "ActorTypeId": "Employee",
        "Username": "177ce294-8d83-4d23-af03-e7cab6caa33d",
        "DtPwdChange": "2016-07-11T00:00:00",
        "Instructions": "2",
        "WonMemberId": 0,
        "WonLocationId": 0,
        "WonServiceRadius": 0,
        "IsElectronicPayment": false,
        "ProviderStatusId": "NA",
        "LabelId": 0,
        "FreeTextAllowed": true,
        "RadiusUnit": "Mile",
        "Password": "Password@12345",
        "Number": "123",
        "JobTitle": "test",
        "FederalId": "",
        "ExternalId": "",
        "ForcePasswordReset": false,
        "TaxWarnOnly": false,
        "PriceLists": [],
        "CustomFields": [],
        "BillAtZero": false,
        "IsSupplier": false,
        "ProviderTypeId": "Regular",
        "ContactAddresses": [],
        "Teams": [],
        "WorkZones": [],
        "Portfolios": [],
        "CustomerGroups": [],
        "Specialties": [],
        "PayRates": [],
        "StockLocations": [],
        "Services": [],
        "AlertSubscriptions": [],
        "TaxExempt": false,
        "LimitAssignmentByPortfolioId": 0,
        "IsRemoved": true,
        "ConcurrencyId": 4,
        "Id": 5,
        "PerformDeletion": false,
        "IsNew": true
    }
}'
200 OK
Example Response
json
{
  "EntitySpecifier": {
    "ConcurrencyId": 6,
    "EntityType": "Employee",
    "Id": 5
  }
}
Cache-Control

no-cache

Pragma

no-cache

Content-Type

application/json; charset=utf-8

Expires

-1

Date

Tue, 08 Mar 2022 07:15:15 GMT

Content-Length

70

Strict-Transport-Security

max-age=31536000; includeSubDomains

DELETEDelete Employee

https://am-ce98c.corrigo.com/api/v1/base/Employee/2
AUTHORIZATIONOAuth 2.0
HEADERS
CompanyName

RDC CE Sandbox

Example Request
Delete Employee
curl
curl --location --request DELETE 'https://am-ce98c.corrigo.com/api/v1/base/Employee/2' \
--header 'CompanyName: RDC CE Sandbox'
200 OK
Example Response
json
{
  "EntitySpecifier": {
    "EntityType": "Employee",
    "Id": 2
  }
}
Cache-Control

no-cache

Pragma

no-cache

Content-Type

application/json; charset=utf-8

Expires

-1

Date

Tue, 08 Mar 2022 07:15:33 GMT

Content-Length

52

Strict-Transport-Security

max-age=31536000; includeSubDomains