POST v1/facilities/{facilityId}/vcard/createCard

Inserts the facility virtual card.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
facilityId

string

None.

Body Parameters

The v card data.

VirtualCardParameter
NameDescriptionTypeAdditional information
FacilityId

globally unique identifier

None.

FacilityName

string

None.

FacilityLogo

Collection of byte

None.

Address1

string

None.

Address2

string

None.

City

string

None.

State

string

None.

PostalCode

string

None.

FacilityPhoneNumber

string

None.

SecondaryPhoneNumber

string

None.

Website

string

None.

FacebookProfile

string

None.

TwitterProfile

string

None.

YelpProfile

string

None.

CustomNote

string

None.

Request Formats

application/json, text/json

Sample:
{
  "FacilityId": "07956777-062e-451a-b670-bdbb8a5ad418",
  "FacilityName": "sample string 2",
  "FacilityLogo": "QEA=",
  "Address1": "sample string 3",
  "Address2": "sample string 4",
  "City": "sample string 5",
  "State": "sample string 6",
  "PostalCode": "sample string 7",
  "FacilityPhoneNumber": "sample string 8",
  "SecondaryPhoneNumber": "sample string 9",
  "Website": "sample string 10",
  "FacebookProfile": "sample string 11",
  "TwitterProfile": "sample string 12",
  "YelpProfile": "sample string 13",
  "CustomNote": "sample string 14"
}

application/xml, text/xml

Sample:
<vCardModels.VirtualCardParameter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OpenTech.IssnWebApi.Web.Models">
  <Address1>sample string 3</Address1>
  <Address2>sample string 4</Address2>
  <City>sample string 5</City>
  <CustomNote>sample string 14</CustomNote>
  <FacebookProfile>sample string 11</FacebookProfile>
  <FacilityId>07956777-062e-451a-b670-bdbb8a5ad418</FacilityId>
  <FacilityLogo>QEA=</FacilityLogo>
  <FacilityName>sample string 2</FacilityName>
  <FacilityPhoneNumber>sample string 8</FacilityPhoneNumber>
  <PostalCode>sample string 7</PostalCode>
  <SecondaryPhoneNumber>sample string 9</SecondaryPhoneNumber>
  <State>sample string 6</State>
  <TwitterProfile>sample string 12</TwitterProfile>
  <Website>sample string 10</Website>
  <YelpProfile>sample string 13</YelpProfile>
</vCardModels.VirtualCardParameter>

Response Information

Resource Description

VoidReturn
NameDescriptionTypeAdditional information
Errors

Collection of Exception

None.

IsSuccess

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "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:
<vCardModels.VoidReturn xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OpenTech.IssnWebApi.Web.Models">
  <Errors xmlns:d2p1="http://schemas.datacontract.org/2004/07/System" xmlns="http://schemas.datacontract.org/2004/07/OpenTech.IssnWebApi.Web.Models.BindingModels">
    <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 xmlns="http://schemas.datacontract.org/2004/07/OpenTech.IssnWebApi.Web.Models.BindingModels">true</IsSuccess>
</vCardModels.VoidReturn>