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 /v1/coverage/gaps HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<CoverageGapsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<AssignmentMode>String</AssignmentMode>
<CanApprove>false</CanApprove>
<CanEditPolicy>false</CanEditPolicy>
<CanSeePay>false</CanSeePay>
<Gaps>
<CoverageGap>
<Approvals>
<CoverageApprovalInfo>
<ContactId>0</ContactId>
<ContactName>String</ContactName>
<CoverageApprovalId>0</CoverageApprovalId>
<CoverageGapId>0</CoverageGapId>
<DecidedAtUtc>0001-01-01T00:00:00</DecidedAtUtc>
<DecisionNote>String</DecisionNote>
<Effects>
<CoverageEffect>
<Expl>
<Demand>String</Demand>
<Drill>String</Drill>
<Kind>String</Kind>
<Override>
<Consequence>String</Consequence>
<Who>String</Who>
</Override>
<PlainSentence>String</PlainSentence>
<RuleId>String</RuleId>
<RuleName>String</RuleName>
<Source>
<CascadeLevel>String</CascadeLevel>
<PolicyName>String</PolicyName>
</Source>
<WhatWouldChangeIt>String</WhatWouldChangeIt>
<WhyItExists>String</WhyItExists>
</Expl>
<Icon>String</Icon>
<RuleId>String</RuleId>
<Text>String</Text>
</CoverageEffect>
</Effects>
<RequestedAtUtc>0001-01-01T00:00:00</RequestedAtUtc>
<Status>String</Status>
<Type>String</Type>
</CoverageApprovalInfo>
</Approvals>
<AssignmentMode>String</AssignmentMode>
<Blocked>
<CoverageBlockedCandidate>
<ChangeChip>String</ChangeChip>
<ContactId>0</ContactId>
<Expl>
<Demand>String</Demand>
<Drill>String</Drill>
<Kind>String</Kind>
<Override>
<Consequence>String</Consequence>
<Who>String</Who>
</Override>
<PlainSentence>String</PlainSentence>
<RuleId>String</RuleId>
<RuleName>String</RuleName>
<Source>
<CascadeLevel>String</CascadeLevel>
<PolicyName>String</PolicyName>
</Source>
<WhatWouldChangeIt>String</WhatWouldChangeIt>
<WhyItExists>String</WhyItExists>
</Expl>
<Initials>String</Initials>
<Name>String</Name>
<Reason>String</Reason>
</CoverageBlockedCandidate>
</Blocked>
<BranchId>00000000-0000-0000-0000-000000000000</BranchId>
<Candidates>
<CoverageCandidate>
<Billed>0</Billed>
<Checks>
<CoverageCandidateCheck>
<CheckId>String</CheckId>
<Expl>
<Demand>String</Demand>
<Drill>String</Drill>
<Kind>String</Kind>
<Override>
<Consequence>String</Consequence>
<Who>String</Who>
</Override>
<PlainSentence>String</PlainSentence>
<RuleId>String</RuleId>
<RuleName>String</RuleName>
<Source>
<CascadeLevel>String</CascadeLevel>
<PolicyName>String</PolicyName>
</Source>
<WhatWouldChangeIt>String</WhatWouldChangeIt>
<WhyItExists>String</WhyItExists>
</Expl>
<Result>String</Result>
</CoverageCandidateCheck>
</Checks>
<Confirm>
<CoverageEffect>
<Expl>
<Demand>String</Demand>
<Drill>String</Drill>
<Kind>String</Kind>
<Override>
<Consequence>String</Consequence>
<Who>String</Who>
</Override>
<PlainSentence>String</PlainSentence>
<RuleId>String</RuleId>
<RuleName>String</RuleName>
<Source>
<CascadeLevel>String</CascadeLevel>
<PolicyName>String</PolicyName>
</Source>
<WhatWouldChangeIt>String</WhatWouldChangeIt>
<WhyItExists>String</WhyItExists>
</Expl>
<Icon>String</Icon>
<RuleId>String</RuleId>
<Text>String</Text>
</CoverageEffect>
</Confirm>
<ContactId>0</ContactId>
<CostLine>String</CostLine>
<CostTone>String</CostTone>
<DiffLine>String</DiffLine>
<FirstName>String</FirstName>
<HasWarn>false</HasWarn>
<Initials>String</Initials>
<Loaded>0</Loaded>
<MarginPct>0</MarginPct>
<MarginTone>String</MarginTone>
<Name>String</Name>
<OtHours>0</OtHours>
<OtPremium>0</OtPremium>
<Preview>
<CoverageEffect>
<Expl>
<Demand>String</Demand>
<Drill>String</Drill>
<Kind>String</Kind>
<Override>
<Consequence>String</Consequence>
<Who>String</Who>
</Override>
<PlainSentence>String</PlainSentence>
<RuleId>String</RuleId>
<RuleName>String</RuleName>
<Source>
<CascadeLevel>String</CascadeLevel>
<PolicyName>String</PolicyName>
</Source>
<WhatWouldChangeIt>String</WhatWouldChangeIt>
<WhyItExists>String</WhyItExists>
</Expl>
<Icon>String</Icon>
<RuleId>String</RuleId>
<Text>String</Text>
</CoverageEffect>
</Preview>
<Rank>0</Rank>
<RankExpl>
<Demand>String</Demand>
<Drill>String</Drill>
<Kind>String</Kind>
<Override>
<Consequence>String</Consequence>
<Who>String</Who>
</Override>
<PlainSentence>String</PlainSentence>
<RuleId>String</RuleId>
<RuleName>String</RuleName>
<Source>
<CascadeLevel>String</CascadeLevel>
<PolicyName>String</PolicyName>
</Source>
<WhatWouldChangeIt>String</WhatWouldChangeIt>
<WhyItExists>String</WhyItExists>
</RankExpl>
</CoverageCandidate>
</Candidates>
<CoverageGapId>0</CoverageGapId>
<CoverageGapUID>00000000-0000-0000-0000-000000000000</CoverageGapUID>
<CreatedAt>0001-01-01T00:00:00</CreatedAt>
<CustomerName>String</CustomerName>
<DecidedPolicyVersionId>0</DecidedPolicyVersionId>
<FilledByContactID>0</FilledByContactID>
<FilledByName>String</FilledByName>
<JobID>0</JobID>
<JobName>String</JobName>
<Leave>
<Began>0001-01-01T00:00:00</Began>
<ChainedGapIds xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:int>0</d5p1:int>
</ChainedGapIds>
<CheckpointDays>0</CheckpointDays>
<Checkpoints>
<CoverageLeaveCheckpoint>
<AtUtc>0001-01-01T00:00:00</AtUtc>
<ByName>String</ByName>
<Note>String</Note>
</CoverageLeaveCheckpoint>
</Checkpoints>
<EstReturn>0001-01-01T00:00:00</EstReturn>
<Fmla>false</Fmla>
<InterimContactId>0</InterimContactId>
<InterimEnd>0001-01-01T00:00:00</InterimEnd>
<InterimName>String</InterimName>
<InterimStart>0001-01-01T00:00:00</InterimStart>
<NextCheckpointUtc>0001-01-01T00:00:00</NextCheckpointUtc>
<ParentLeaveGapId>0</ParentLeaveGapId>
<RequisitionOpened>false</RequisitionOpened>
<RestoredAtUtc>0001-01-01T00:00:00</RestoredAtUtc>
<StaffPostingId>0</StaffPostingId>
</Leave>
<MoveOptions>
<CoverageMoveOption>
<Detail>String</Detail>
<Expl>
<Demand>String</Demand>
<Drill>String</Drill>
<Kind>String</Kind>
<Override>
<Consequence>String</Consequence>
<Who>String</Who>
</Override>
<PlainSentence>String</PlainSentence>
<RuleId>String</RuleId>
<RuleName>String</RuleName>
<Source>
<CascadeLevel>String</CascadeLevel>
<PolicyName>String</PolicyName>
</Source>
<WhatWouldChangeIt>String</WhatWouldChangeIt>
<WhyItExists>String</WhyItExists>
</Expl>
<Key>String</Key>
<Label>String</Label>
</CoverageMoveOption>
</MoveOptions>
<MustFill>false</MustFill>
<MustFillExpl>
<Demand>String</Demand>
<Drill>String</Drill>
<Kind>String</Kind>
<Override>
<Consequence>String</Consequence>
<Who>String</Who>
</Override>
<PlainSentence>String</PlainSentence>
<RuleId>String</RuleId>
<RuleName>String</RuleName>
<Source>
<CascadeLevel>String</CascadeLevel>
<PolicyName>String</PolicyName>
</Source>
<WhatWouldChangeIt>String</WhatWouldChangeIt>
<WhyItExists>String</WhyItExists>
</MustFillExpl>
<NoShow>
<Attempts>
<CoverageNoShowAttempt>
<AtUtc>0001-01-01T00:00:00</AtUtc>
<Channel>String</Channel>
<Note>String</Note>
</CoverageNoShowAttempt>
</Attempts>
<AttendanceNote>false</AttendanceNote>
<DeclaredAtUtc>0001-01-01T00:00:00</DeclaredAtUtc>
<FalseAlarm>false</FalseAlarm>
<GraceUntilUtc>0001-01-01T00:00:00</GraceUntilUtc>
</NoShow>
<Offers>
<CoverageOfferInfo>
<Channel>String</Channel>
<ContactId>0</ContactId>
<CoverageOfferId>0</CoverageOfferId>
<Name>String</Name>
<RespondedAtUtc>0001-01-01T00:00:00</RespondedAtUtc>
<Ring>0</Ring>
<SentAtUtc>0001-01-01T00:00:00</SentAtUtc>
<Status>String</Status>
</CoverageOfferInfo>
</Offers>
<OrderExpl>
<Demand>String</Demand>
<Drill>String</Drill>
<Kind>String</Kind>
<Override>
<Consequence>String</Consequence>
<Who>String</Who>
</Override>
<PlainSentence>String</PlainSentence>
<RuleId>String</RuleId>
<RuleName>String</RuleName>
<Source>
<CascadeLevel>String</CascadeLevel>
<PolicyName>String</PolicyName>
</Source>
<WhatWouldChangeIt>String</WhatWouldChangeIt>
<WhyItExists>String</WhyItExists>
</OrderExpl>
<OutContactID>0</OutContactID>
<OutInitials>String</OutInitials>
<OutName>String</OutName>
<ProjectID>0</ProjectID>
<QualifiedLine>String</QualifiedLine>
<Reason>String</Reason>
<RecordNo>String</RecordNo>
<Status>String</Status>
<Timeline>
<CoverageGapEventInfo>
<AtUtc>0001-01-01T00:00:00</AtUtc>
<Channel>String</Channel>
<ContactName>String</ContactName>
<Detail>String</Detail>
<EventType>String</EventType>
</CoverageGapEventInfo>
</Timeline>
<Track>String</Track>
<UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
<WindowEnd>0001-01-01T00:00:00</WindowEnd>
<WindowStart>0001-01-01T00:00:00</WindowStart>
<WorkerScheduleItemID>0</WorkerScheduleItemID>
</CoverageGap>
</Gaps>
<LockLine>String</LockLine>
<PolicyName>String</PolicyName>
<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>
</CoverageGapsResponse>