Viviot.Api

GetShift

**Requires Authentication**
Requires any of the roles:	Admin, TenantAdmin, TeamAdmin

The following routes are available for this service:
GET	/shift	Get a shift by ID.

**GetShift** Parameters:
Name	Parameter	Data Type	Required	Description
Id	query	string	Yes	Shift Id (GUID)

**BaseRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Version	form	integer	No	Api version

**ShiftResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Shifts	form	List<ShiftDto>	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No

**ShiftDto** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid?	No
OrganizationId	form	Guid	No
Name	form	string	No
TeamId	form	Guid?	No
StartTimeOffset	form	int	No
EndTimeOffset	form	int	No
StartDate	form	DateTime?	No
EndDate	form	DateTime?	No
ShiftMembers	form	List<ShiftMemberDto>	No

**ShiftMemberDto** Parameters:
Name	Parameter	Data Type	Required
BusinessUserId	form	int	No
FirstName	form	string	No
LastName	form	string	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /shift HTTP/1.1 
Host: api.4spaces.io 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ShiftResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Api.Business">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Api.Base">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Shifts xmlns:d2p1="http://schemas.datacontract.org/2004/07/Viviot.Infrastructure.Dto.Shift">
    <d2p1:ShiftDto>
      <d2p1:EndDate>0001-01-01T00:00:00</d2p1:EndDate>
      <d2p1:EndTimeOffset>0</d2p1:EndTimeOffset>
      <d2p1:Id>00000000-0000-0000-0000-000000000000</d2p1:Id>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:OrganizationId>00000000-0000-0000-0000-000000000000</d2p1:OrganizationId>
      <d2p1:ShiftMembers>
        <d2p1:ShiftMemberDto>
          <d2p1:BusinessUserId>0</d2p1:BusinessUserId>
          <d2p1:FirstName>String</d2p1:FirstName>
          <d2p1:LastName>String</d2p1:LastName>
        </d2p1:ShiftMemberDto>
      </d2p1:ShiftMembers>
      <d2p1:StartDate>0001-01-01T00:00:00</d2p1:StartDate>
      <d2p1:StartTimeOffset>0</d2p1:StartTimeOffset>
      <d2p1:TeamId>00000000-0000-0000-0000-000000000000</d2p1:TeamId>
    </d2p1:ShiftDto>
  </Shifts>
</ShiftResponse>