| Requires any of the roles: | Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator |
| GET,POST,DELETE,OPTIONS | /v1/CustomerCheckins/{Id} | ||
|---|---|---|---|
| GET,POST,DELETE,OPTIONS | /v1/CustomerCheckins |
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
open class CustomerCheckins : CustomerCheckinObject()
{
open var ApiKey:UUID? = null
}
open class CustomerCheckinObject
{
open var Id:UUID? = null
open var LineId:UUID? = null
open var CustomerId:UUID? = null
open var EmployeeId:UUID? = null
open var LocationId:UUID? = null
open var StationId:UUID? = null
open var SignInTime:Date? = null
open var AdjustedSignInTime:Date? = null
open var SendReminders:Boolean? = null
open var Status:Int? = null
open var TaskTime:Int? = null
open var Completed:Boolean? = null
open var CompletedTime:Date? = null
open var QuestionnaireSubmitted:Boolean? = null
open var LineIds:ArrayList<UUID> = ArrayList<UUID>()
}
open class CustomerCheckinsResponse
{
open var ResponseStatus:ResponseStatus? = null
open var CustomerCheckins:ArrayList<CustomerCheckinObject> = ArrayList<CustomerCheckinObject>()
open var CustomerCheckinRequirements:CheckinInformation? = null
}
open class CheckinInformation
{
open var Id:UUID? = null
open var LocationId:UUID? = null
open var LocationName:String? = null
open var CustomerId:UUID? = null
open var QuestionnaireSubmitted:Boolean? = null
open var Name:String? = null
open var Description:String? = null
open var TotalServiceDurationMinutes:Int? = null
open var TotalCost:BigDecimal? = null
open var SendQuestionnaire:Boolean? = null
open var RequireUpload:Boolean? = null
open var Questions:ArrayList<LineQuestion> = ArrayList<LineQuestion>()
open var Lines:ArrayList<Line> = ArrayList<Line>()
}
open class LineQuestion
{
open var Id:Int? = null
open var CustomerCheckInId:UUID? = null
open var LineId:UUID? = null
open var Question:String? = null
open var Answer:String? = null
open var Active:Boolean? = null
}
open class Line
{
open var Id:UUID? = null
open var LocationId:UUID? = null
open var LocationName:String? = null
open var Name:String? = null
open var Description:String? = null
open var ServiceDurationMinutes:Int? = null
open var WaitTime:Int? = null
open var Cost:BigDecimal? = null
open var UpperThreshold:Int? = null
open var LowerThreshold:Int? = null
open var Active:Boolean? = null
open var EntDate:Date? = null
open var ModDate:Date? = null
open var SendQuestionnaire:Boolean? = null
open var RequireUpload:Boolean? = null
open var UploadMessage:String? = null
open var LineImages:ArrayList<LineImage> = ArrayList<LineImage>()
}
open class LineImage
{
open var ImageId:UUID? = null
open var FileName:String? = null
open var ImageTitle:String? = null
open var UploadDate:Date? = null
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/CustomerCheckins/{Id} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<CustomerCheckins xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<AdjustedSignInTime>0001-01-01T00:00:00</AdjustedSignInTime>
<Completed>false</Completed>
<CompletedTime>0001-01-01T00:00:00</CompletedTime>
<CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
<EmployeeId>00000000-0000-0000-0000-000000000000</EmployeeId>
<Id>00000000-0000-0000-0000-000000000000</Id>
<LineId>00000000-0000-0000-0000-000000000000</LineId>
<LineIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
</LineIds>
<LocationId>00000000-0000-0000-0000-000000000000</LocationId>
<QuestionnaireSubmitted>false</QuestionnaireSubmitted>
<SendReminders>false</SendReminders>
<SignInTime>0001-01-01T00:00:00</SignInTime>
<StationId>00000000-0000-0000-0000-000000000000</StationId>
<Status>0</Status>
<TaskTime>0</TaskTime>
<ApiKey>00000000-0000-0000-0000-000000000000</ApiKey>
</CustomerCheckins>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<CustomerCheckinsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<CustomerCheckinRequirements>
<CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
<Description>String</Description>
<Id>00000000-0000-0000-0000-000000000000</Id>
<Lines>
<Line>
<Active>false</Active>
<Cost>0</Cost>
<Description>String</Description>
<EntDate>0001-01-01T00:00:00</EntDate>
<Id>00000000-0000-0000-0000-000000000000</Id>
<LineImages>
<LineImage>
<FileName>String</FileName>
<ImageId>00000000-0000-0000-0000-000000000000</ImageId>
<ImageTitle>String</ImageTitle>
<UploadDate>0001-01-01T00:00:00</UploadDate>
</LineImage>
</LineImages>
<LocationId>00000000-0000-0000-0000-000000000000</LocationId>
<LocationName>String</LocationName>
<LowerThreshold>0</LowerThreshold>
<ModDate>0001-01-01T00:00:00</ModDate>
<Name>String</Name>
<RequireUpload>false</RequireUpload>
<SendQuestionnaire>false</SendQuestionnaire>
<ServiceDurationMinutes>0</ServiceDurationMinutes>
<UploadMessage>String</UploadMessage>
<UpperThreshold>0</UpperThreshold>
<WaitTime>0</WaitTime>
</Line>
</Lines>
<LocationId>00000000-0000-0000-0000-000000000000</LocationId>
<LocationName>String</LocationName>
<Name>String</Name>
<QuestionnaireSubmitted>false</QuestionnaireSubmitted>
<Questions>
<LineQuestion>
<Active>false</Active>
<Answer>String</Answer>
<CustomerCheckInId>00000000-0000-0000-0000-000000000000</CustomerCheckInId>
<Id>0</Id>
<LineId>00000000-0000-0000-0000-000000000000</LineId>
<Question>String</Question>
</LineQuestion>
</Questions>
<RequireUpload>false</RequireUpload>
<SendQuestionnaire>false</SendQuestionnaire>
<TotalCost>0</TotalCost>
<TotalServiceDurationMinutes>0</TotalServiceDurationMinutes>
</CustomerCheckinRequirements>
<CustomerCheckins>
<CustomerCheckinObject>
<AdjustedSignInTime>0001-01-01T00:00:00</AdjustedSignInTime>
<Completed>false</Completed>
<CompletedTime>0001-01-01T00:00:00</CompletedTime>
<CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
<EmployeeId>00000000-0000-0000-0000-000000000000</EmployeeId>
<Id>00000000-0000-0000-0000-000000000000</Id>
<LineId>00000000-0000-0000-0000-000000000000</LineId>
<LineIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:guid>00000000-0000-0000-0000-000000000000</d4p1:guid>
</LineIds>
<LocationId>00000000-0000-0000-0000-000000000000</LocationId>
<QuestionnaireSubmitted>false</QuestionnaireSubmitted>
<SendReminders>false</SendReminders>
<SignInTime>0001-01-01T00:00:00</SignInTime>
<StationId>00000000-0000-0000-0000-000000000000</StationId>
<Status>0</Status>
<TaskTime>0</TaskTime>
</CustomerCheckinObject>
</CustomerCheckins>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<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>
</CustomerCheckinsResponse>