ServiceReef

Back POST v1/positions/add

Add a new position

Request Information

URI Parameters

None.

Body Parameters

PositionRequest
Name Description Type Additional information
DateStart

date
DateEnd

date
Title

Job Title

 string

Required
Description

Tell about what someone will be doing in this position and their responsibilities.

 string
Requirements

List any requirements for this position.

 string
CommitmentLength

Optionally enter the length of the committment for this position.

 string
AnnualSalary

decimal number
MaxUsersAssigned

Optionally specify how many people can be interested in or assigned to this position at one time. Leave empty for no limit.

 integer
Status

PositionStatus
Location

AddressRequest
ExternalId

string

Max length: 512

Request Formats

application/json, text/json

Sample: 
{
  "DateStart": "2024-12-22T18:46:35.5040232Z",
  "DateEnd": "2024-12-22T18:46:35.5040232Z",
  "Title": "sample string 1",
  "Description": "sample string 2",
  "Requirements": "sample string 3",
  "CommitmentLength": "sample string 4",
  "AnnualSalary": 1.0,
  "MaxUsersAssigned": 1,
  "Status": "Draft",
  "Location": {
    "Address1": "sample string 1",
    "Address2": "sample string 2",
    "City": "sample string 3",
    "State": "sample string 4",
    "Zip": "sample string 5",
    "Country": "sample string 6",
    "Name": "sample string 7"
  },
  "ExternalId": "sample string 5"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Sample Request

https://api.servicereef.com/v1/positions/add?model={model}

Response Information

Resource Description

OrganizationPositionResult
Name Description Type Additional information
DateCreated

date
MaxMembersAssigned

integer
NumberOfAssignedMembers

integer
NumberOfInquiringMembers

integer
Budgets

Collection of PositionBudgetModel
Location

AddressModel
Admins

Collection of BasicUserModel
PositionId

integer
Title

string
Description

string
Requirements

string
DateStart

date
DateEnd

date
CommitmentLength

string
AnnualSalary

decimal number
Status

PositionStatus
ExternalId

string

Try API

Try this endpoint by entering your credentials and using the API Explorer.

Try With API Explorer

Response Formats

application/json, text/json

Sample: 
{
  "DateCreated": "2024-12-22T18:46:35.5196475Z",
  "MaxMembersAssigned": 1,
  "NumberOfAssignedMembers": 2,
  "NumberOfInquiringMembers": 3,
  "Budgets": [
    {
      "BudgetId": 1,
      "BudgetItems": [
        {
          "Amount": 1.0,
          "BudgetCategory": "sample string 2",
          "BudgetStage": "sample string 3",
          "Title": "sample string 4",
          "Description": "sample string 5",
          "Frequency": "OneTime",
          "Name": "sample string 6",
          "Quantity": 7
        },
        {
          "Amount": 1.0,
          "BudgetCategory": "sample string 2",
          "BudgetStage": "sample string 3",
          "Title": "sample string 4",
          "Description": "sample string 5",
          "Frequency": "OneTime",
          "Name": "sample string 6",
          "Quantity": 7
        }
      ],
      "AnnualTotal": 2.0
    },
    {
      "BudgetId": 1,
      "BudgetItems": [
        {
          "Amount": 1.0,
          "BudgetCategory": "sample string 2",
          "BudgetStage": "sample string 3",
          "Title": "sample string 4",
          "Description": "sample string 5",
          "Frequency": "OneTime",
          "Name": "sample string 6",
          "Quantity": 7
        },
        {
          "Amount": 1.0,
          "BudgetCategory": "sample string 2",
          "BudgetStage": "sample string 3",
          "Title": "sample string 4",
          "Description": "sample string 5",
          "Frequency": "OneTime",
          "Name": "sample string 6",
          "Quantity": 7
        }
      ],
      "AnnualTotal": 2.0
    }
  ],
  "Location": {
    "Latitude": 1.1,
    "Longitude": 1.1,
    "Address1": "sample string 1",
    "Address2": "sample string 2",
    "City": "sample string 3",
    "State": "sample string 4",
    "Zip": "sample string 5",
    "Country": "sample string 6",
    "Name": "sample string 7"
  },
  "Admins": [
    {
      "UserId": 1,
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "Email": "sample string 4"
    },
    {
      "UserId": 1,
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "Email": "sample string 4"
    }
  ],
  "PositionId": 4,
  "Title": "sample string 5",
  "Description": "sample string 6",
  "Requirements": "sample string 7",
  "DateStart": "2024-12-22T18:46:35.5196475Z",
  "DateEnd": "2024-12-22T18:46:35.5196475Z",
  "CommitmentLength": "sample string 8",
  "AnnualSalary": 1.0,
  "Status": "Draft",
  "ExternalId": "sample string 9"
}