| GET,POST,PUT,DELETE,OPTIONS | /v1/Equipment | ||
|---|---|---|---|
| GET,POST,PUT,DELETE,OPTIONS | /v1/Equipment/{EquipmentID} |
import Foundation
import ServiceStack
public class EquipmentRequest : Codable
{
public var equipmentID:Int
public var equipment:[Equipment] = []
required public init(){}
}
public class Equipment : Codable
{
public var equipmentID:Int
public var equipmentName:String
public var equipmentTypeID:Int16
public var manufacturer:String
public var equipmentType:String
public var serialNumber:String
public var barCode:String
public var equipmentLocation:String
public var imageURL:String
public var productDetailsURL:String
public var recordCreatedDate:Date
public var createdByUID:String
public var active:Bool
public var notes:String
public var rate:Double
public var branchId:String
public var branchName:String
public var ownership:String
public var rentalVendor:String
public var rentalStart:Date?
public var rentalEnd:Date?
public var projects:[Project] = []
required public init(){}
}
public class Project : Codable
{
public var projectID:Int
public var projectUID:String
public var projectName:String
public var imageURL:String
public var imageKey:String
public var clientName:String
public var clientPhone:String
public var clientEmail:String
public var notifyCustomerOnVisitCompletion:Bool
public var clientContactID:Int?
public var projectManagerID:Int
public var projectManagerName:String
public var startDate:Date?
public var endDate:Date?
public var actualStartDate:Date?
public var actualEndDate:Date?
public var jobCount:Int
public var crewMemberCount:Int
public var crewAvatarsJson:String
public var crewNamesSearch:String
public var equipmentCount:Int
public var materialCount:Int
public var projectStatusID:Int16
public var projectStatusDescription:String
public var budget:Double
public var costToDate:Double
public var projectLocation:String
public var projectType:String
public var projectSponsor:String
public var createdBy:String
public var createdAt:Date?
public var updatedAt:Date?
public var projectDescription:String
public var scope:String
public var statusId:Int
public var branchId:String
public var branchName:String
public var location:Location
required public init(){}
}
public class Location : Codable
{
public var id:String
public var clientId:String
public var name:String
public var address1:String
public var address2:String
public var city:String
public var state:String
public var zip:String
public var phone:String
public var fax:String
public var url:String
public var email:String
public var timeZone:String
public var active:Bool
public var entDate:Date
public var modDate:Date
public var locationImage:String
required public init(){}
}
public class EquipmentResponse : Codable
{
public var responseStatus:ResponseStatus
public var equipment:[Equipment] = []
required public init(){}
}
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/Equipment HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<EquipmentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Equipment>
<Equipment>
<Active>false</Active>
<BarCode>String</BarCode>
<BranchId>00000000-0000-0000-0000-000000000000</BranchId>
<BranchName>String</BranchName>
<CreatedByUID>00000000-0000-0000-0000-000000000000</CreatedByUID>
<EquipmentID>0</EquipmentID>
<EquipmentLocation>String</EquipmentLocation>
<EquipmentName>String</EquipmentName>
<EquipmentType>String</EquipmentType>
<EquipmentTypeID>0</EquipmentTypeID>
<ImageURL>String</ImageURL>
<Manufacturer>String</Manufacturer>
<Notes>String</Notes>
<Ownership>String</Ownership>
<ProductDetailsURL>String</ProductDetailsURL>
<Projects>
<Project>
<ActualEndDate>0001-01-01T00:00:00</ActualEndDate>
<ActualStartDate>0001-01-01T00:00:00</ActualStartDate>
<BranchId>00000000-0000-0000-0000-000000000000</BranchId>
<BranchName>String</BranchName>
<Budget>0</Budget>
<ClientContactID>0</ClientContactID>
<ClientEmail>String</ClientEmail>
<ClientName>String</ClientName>
<ClientPhone>String</ClientPhone>
<CostToDate>0</CostToDate>
<CreatedAt>0001-01-01T00:00:00</CreatedAt>
<CreatedBy>String</CreatedBy>
<CrewAvatarsJson>String</CrewAvatarsJson>
<CrewMemberCount>0</CrewMemberCount>
<CrewNamesSearch>String</CrewNamesSearch>
<EndDate>0001-01-01T00:00:00</EndDate>
<EquipmentCount>0</EquipmentCount>
<ImageKey>String</ImageKey>
<ImageURL>String</ImageURL>
<JobCount>0</JobCount>
<Location>
<Active>false</Active>
<Address1>String</Address1>
<Address2>String</Address2>
<City>String</City>
<ClientId>00000000-0000-0000-0000-000000000000</ClientId>
<Email>String</Email>
<EntDate>0001-01-01T00:00:00</EntDate>
<Fax>String</Fax>
<Id>00000000-0000-0000-0000-000000000000</Id>
<LocationImage>String</LocationImage>
<ModDate>0001-01-01T00:00:00</ModDate>
<Name>String</Name>
<Phone>String</Phone>
<State>String</State>
<TimeZone>String</TimeZone>
<URL>String</URL>
<Zip>String</Zip>
</Location>
<MaterialCount>0</MaterialCount>
<NotifyCustomerOnVisitCompletion>false</NotifyCustomerOnVisitCompletion>
<ProjectDescription>String</ProjectDescription>
<ProjectID>0</ProjectID>
<ProjectLocation>String</ProjectLocation>
<ProjectManagerID>0</ProjectManagerID>
<ProjectManagerName>String</ProjectManagerName>
<ProjectName>String</ProjectName>
<ProjectSponsor>String</ProjectSponsor>
<ProjectStatusDescription>String</ProjectStatusDescription>
<ProjectStatusID>0</ProjectStatusID>
<ProjectType>String</ProjectType>
<ProjectUID>00000000-0000-0000-0000-000000000000</ProjectUID>
<Scope>String</Scope>
<StartDate>0001-01-01T00:00:00</StartDate>
<StatusId>0</StatusId>
<UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
</Project>
</Projects>
<Rate>0</Rate>
<RecordCreatedDate>0001-01-01T00:00:00</RecordCreatedDate>
<RentalEnd>0001-01-01T00:00:00</RentalEnd>
<RentalStart>0001-01-01T00:00:00</RentalStart>
<RentalVendor>String</RentalVendor>
<SerialNumber>String</SerialNumber>
</Equipment>
</Equipment>
<EquipmentID>0</EquipmentID>
</EquipmentRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<EquipmentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Equipment>
<Equipment>
<Active>false</Active>
<BarCode>String</BarCode>
<BranchId>00000000-0000-0000-0000-000000000000</BranchId>
<BranchName>String</BranchName>
<CreatedByUID>00000000-0000-0000-0000-000000000000</CreatedByUID>
<EquipmentID>0</EquipmentID>
<EquipmentLocation>String</EquipmentLocation>
<EquipmentName>String</EquipmentName>
<EquipmentType>String</EquipmentType>
<EquipmentTypeID>0</EquipmentTypeID>
<ImageURL>String</ImageURL>
<Manufacturer>String</Manufacturer>
<Notes>String</Notes>
<Ownership>String</Ownership>
<ProductDetailsURL>String</ProductDetailsURL>
<Projects>
<Project>
<ActualEndDate>0001-01-01T00:00:00</ActualEndDate>
<ActualStartDate>0001-01-01T00:00:00</ActualStartDate>
<BranchId>00000000-0000-0000-0000-000000000000</BranchId>
<BranchName>String</BranchName>
<Budget>0</Budget>
<ClientContactID>0</ClientContactID>
<ClientEmail>String</ClientEmail>
<ClientName>String</ClientName>
<ClientPhone>String</ClientPhone>
<CostToDate>0</CostToDate>
<CreatedAt>0001-01-01T00:00:00</CreatedAt>
<CreatedBy>String</CreatedBy>
<CrewAvatarsJson>String</CrewAvatarsJson>
<CrewMemberCount>0</CrewMemberCount>
<CrewNamesSearch>String</CrewNamesSearch>
<EndDate>0001-01-01T00:00:00</EndDate>
<EquipmentCount>0</EquipmentCount>
<ImageKey>String</ImageKey>
<ImageURL>String</ImageURL>
<JobCount>0</JobCount>
<Location>
<Active>false</Active>
<Address1>String</Address1>
<Address2>String</Address2>
<City>String</City>
<ClientId>00000000-0000-0000-0000-000000000000</ClientId>
<Email>String</Email>
<EntDate>0001-01-01T00:00:00</EntDate>
<Fax>String</Fax>
<Id>00000000-0000-0000-0000-000000000000</Id>
<LocationImage>String</LocationImage>
<ModDate>0001-01-01T00:00:00</ModDate>
<Name>String</Name>
<Phone>String</Phone>
<State>String</State>
<TimeZone>String</TimeZone>
<URL>String</URL>
<Zip>String</Zip>
</Location>
<MaterialCount>0</MaterialCount>
<NotifyCustomerOnVisitCompletion>false</NotifyCustomerOnVisitCompletion>
<ProjectDescription>String</ProjectDescription>
<ProjectID>0</ProjectID>
<ProjectLocation>String</ProjectLocation>
<ProjectManagerID>0</ProjectManagerID>
<ProjectManagerName>String</ProjectManagerName>
<ProjectName>String</ProjectName>
<ProjectSponsor>String</ProjectSponsor>
<ProjectStatusDescription>String</ProjectStatusDescription>
<ProjectStatusID>0</ProjectStatusID>
<ProjectType>String</ProjectType>
<ProjectUID>00000000-0000-0000-0000-000000000000</ProjectUID>
<Scope>String</Scope>
<StartDate>0001-01-01T00:00:00</StartDate>
<StatusId>0</StatusId>
<UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
</Project>
</Projects>
<Rate>0</Rate>
<RecordCreatedDate>0001-01-01T00:00:00</RecordCreatedDate>
<RentalEnd>0001-01-01T00:00:00</RentalEnd>
<RentalStart>0001-01-01T00:00:00</RentalStart>
<RentalVendor>String</RentalVendor>
<SerialNumber>String</SerialNumber>
</Equipment>
</Equipment>
<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>
</EquipmentResponse>