GET v1/xpresscollect/{facilityId}/documenttemplates

Gets the xpress collect facility document templates.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
facilityId

The facility identifier.

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

XpressCollectFacilityDocumentTemplatesBindingModel
NameDescriptionTypeAdditional information
FacilityDocumentTemplates

Collection of XpressCollectFacilityDocumentTemplateItem

None.

Errors

Collection of Exception

None.

IsSuccess

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "FacilityDocumentTemplates": [
    {
      "LiveHtmlDocsId": "93b2e50a-f282-4bb4-9e74-b13e2e457f99",
      "Source": "sample string 2",
      "UseType": 3,
      "UseTypeDescription": "sample string 4",
      "Title": "sample string 5",
      "HtmlBlob": "QEA=",
      "FacilityId": "293ab06b-c1e2-408a-81bd-662ca87efeba",
      "AccountId": "586881a6-29ce-45e3-b164-d91c86604d27",
      "DocType": 8,
      "SubjectLine": "sample string 9"
    },
    {
      "LiveHtmlDocsId": "93b2e50a-f282-4bb4-9e74-b13e2e457f99",
      "Source": "sample string 2",
      "UseType": 3,
      "UseTypeDescription": "sample string 4",
      "Title": "sample string 5",
      "HtmlBlob": "QEA=",
      "FacilityId": "293ab06b-c1e2-408a-81bd-662ca87efeba",
      "AccountId": "586881a6-29ce-45e3-b164-d91c86604d27",
      "DocType": 8,
      "SubjectLine": "sample string 9"
    }
  ],
  "Errors": [
    {
      "ClassName": "System.Exception",
      "Message": null,
      "Data": null,
      "InnerException": null,
      "HelpURL": "sample string 1",
      "StackTraceString": null,
      "RemoteStackTraceString": null,
      "RemoteStackIndex": 0,
      "ExceptionMethod": null,
      "HResult": 3,
      "Source": "sample string 2",
      "WatsonBuckets": null
    },
    {
      "ClassName": "System.Exception",
      "Message": null,
      "Data": null,
      "InnerException": null,
      "HelpURL": "sample string 1",
      "StackTraceString": null,
      "RemoteStackTraceString": null,
      "RemoteStackIndex": 0,
      "ExceptionMethod": null,
      "HResult": 3,
      "Source": "sample string 2",
      "WatsonBuckets": null
    }
  ],
  "IsSuccess": true
}

application/xml, text/xml

Sample:
<XpressCollectFacilityDocumentTemplatesBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OpenTech.IssnWebApi.Web.Models.BindingModels">
  <Errors xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:Exception>
      <ClassName xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">System.Exception</ClassName>
      <Message i:nil="true" xmlns="" />
      <Data i:nil="true" xmlns="" />
      <InnerException i:nil="true" xmlns="" />
      <HelpURL xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 1</HelpURL>
      <StackTraceString i:nil="true" xmlns="" />
      <RemoteStackTraceString i:nil="true" xmlns="" />
      <RemoteStackIndex xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">0</RemoteStackIndex>
      <ExceptionMethod i:nil="true" xmlns="" />
      <HResult xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">3</HResult>
      <Source xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 2</Source>
      <WatsonBuckets i:nil="true" xmlns="" />
    </d2p1:Exception>
    <d2p1:Exception>
      <ClassName xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">System.Exception</ClassName>
      <Message i:nil="true" xmlns="" />
      <Data i:nil="true" xmlns="" />
      <InnerException i:nil="true" xmlns="" />
      <HelpURL xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 1</HelpURL>
      <StackTraceString i:nil="true" xmlns="" />
      <RemoteStackTraceString i:nil="true" xmlns="" />
      <RemoteStackIndex xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">0</RemoteStackIndex>
      <ExceptionMethod i:nil="true" xmlns="" />
      <HResult xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">3</HResult>
      <Source xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 2</Source>
      <WatsonBuckets i:nil="true" xmlns="" />
    </d2p1:Exception>
  </Errors>
  <IsSuccess>true</IsSuccess>
  <FacilityDocumentTemplates>
    <XpressCollectFacilityDocumentTemplateItem>
      <AccountId>586881a6-29ce-45e3-b164-d91c86604d27</AccountId>
      <DocType>8</DocType>
      <FacilityId>293ab06b-c1e2-408a-81bd-662ca87efeba</FacilityId>
      <HtmlBlob>QEA=</HtmlBlob>
      <LiveHtmlDocsId>93b2e50a-f282-4bb4-9e74-b13e2e457f99</LiveHtmlDocsId>
      <Source>sample string 2</Source>
      <SubjectLine>sample string 9</SubjectLine>
      <Title>sample string 5</Title>
      <UseType>3</UseType>
      <UseTypeDescription>sample string 4</UseTypeDescription>
    </XpressCollectFacilityDocumentTemplateItem>
    <XpressCollectFacilityDocumentTemplateItem>
      <AccountId>586881a6-29ce-45e3-b164-d91c86604d27</AccountId>
      <DocType>8</DocType>
      <FacilityId>293ab06b-c1e2-408a-81bd-662ca87efeba</FacilityId>
      <HtmlBlob>QEA=</HtmlBlob>
      <LiveHtmlDocsId>93b2e50a-f282-4bb4-9e74-b13e2e457f99</LiveHtmlDocsId>
      <Source>sample string 2</Source>
      <SubjectLine>sample string 9</SubjectLine>
      <Title>sample string 5</Title>
      <UseType>3</UseType>
      <UseTypeDescription>sample string 4</UseTypeDescription>
    </XpressCollectFacilityDocumentTemplateItem>
  </FacilityDocumentTemplates>
</XpressCollectFacilityDocumentTemplatesBindingModel>