Create shift assignment

POST 
https://api.maple.com/api/v1/shifts/:shiftId/assignments

Authorization: x-api-key

name: x-api-keytype: apiKeyin: headerdescription: Your Maple API Key

Create a shift assignment, creating the worker if it does not exist.

Request

Path Parameters

shiftId stringrequired

application/json

Body

required

data objectrequired
attributes objectrequired
externalUserId stringrequired
firstName stringrequired
lastName stringrequired
workerType stringrequired
Accepts CNA, LVN, RN, CAREGIVER, Medication Aide
email string
phone string
type stringrequired

Responses

200

application/json

Schema

Schema

data objectrequired
attributes objectrequired
externalUserId stringrequired
firstName stringrequired
lastName stringrequired
email string
phone string
id stringrequired
type stringrequired

Example (from schema)

{
  "data": {
    "attributes": {
      "externalUserId": "string",
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "phone": "string"
    },
    "id": "string",
    "type": "string"
  }
}

4XX

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
id stringrequired
status stringrequired
title stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "id": "string",
      "status": "string",
      "title": "string"
    }
  ]
}

5XX

application/json

Schema

Schema

errors object[]required
Array [
code stringrequired
id stringrequired
status stringrequired
title stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "code": "string",
      "id": "string",
      "status": "string",
      "title": "string"
    }
  ]
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X POST 'https://api.maple.com/api/v1/shifts/:shiftId/assignments' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'x-api-key: <API_KEY_VALUE>' \
--data-raw '{
  "data": {
    "attributes": {
      "externalUserId": "string",
      "firstName": "string",
      "lastName": "string",
      "workerType": "string",
      "email": "string",
      "phone": "string"
    },
    "type": "string"
  }
}'

Request Collapse all

Base URL

https://api.maple.com

Auth

x-api-key

Parameters

shiftId — pathrequired

Body required

{
  "data": {
    "attributes": {
      "externalUserId": "string",
      "firstName": "string",
      "lastName": "string",
      "workerType": "string",
      "email": "string",
      "phone": "string"
    },
    "type": "string"
  }
}

ResponseClear

Click the Send API Request button above and see the response here!