AddCoverage

Creates a Coverage with the specified details and adds it to an existing Group. (For sample SOAP requests, see "Shift types", below.)

Request Parameters

Name

Description

Type

Optional

groupName

Name of the Group to which you want to add the Coverage

string

no

coverage

Specifies the following:

name: Coverage name

teamName: name of the Team associated with the Coverage (may be null)

The Coverage details must include one of the following three shift types (if the other two are included, they must be set to nil): oneTimeShift, recurringShift, or holidayShift.

SoapCoverageParameter

no

Shift types

oneTimeShift (Sample SOAP Request)

Specifies a single-instance Coverage with the following details:

recurringShift (Sample SOAP Request)

Specifies a recurring Coverage with the following details:

holidayShift (Sample SOAP Request)

Specifies a holiday-only Coverage with the following details:

Sample SOAP Response

Response Parameters

Name

Description

Type

serverTimestamp

Time corresponding to the server time when the request was made (this should match the associated persisted audit event)

string

status

Final status of the request.

string

Standard SOAP Parameters

SOAP Response Status Messages