GET api/v1/VisitorRequestInstances/Badge?VisitorRequestInstanceId={VisitorRequestInstanceId}

Returns the Badge SVG as a string

Request Information

URI Parameters

NameDescriptionTypeAdditional information
VisitorRequestInstanceId

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

ResultWithSVG
NameDescriptionTypeAdditional information
SVG

Represents the badge SVG data

BadgeData

None.

ResultCode

Represents the result code

integer

None.

Description

Represents a description of the result code

string

None.

Response Formats

application/json, text/json

Sample:
{
  "SVG": {
    "SvgFile": "sample string 1",
    "Width": 2,
    "Height": 3,
    "WebFonts": "sample string 4"
  },
  "ResultCode": 1,
  "Description": "sample string 2"
}

application/xml, text/xml

Sample:
<ResultWithSVG xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers">
  <Description>sample string 2</Description>
  <HttpStatusCode>Continue</HttpStatusCode>
  <ResultCode>1</ResultCode>
  <SVG xmlns:d2p1="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers.VisitorBadge">
    <d2p1:Height>3</d2p1:Height>
    <d2p1:SvgFile>sample string 1</d2p1:SvgFile>
    <d2p1:WebFonts>sample string 4</d2p1:WebFonts>
    <d2p1:Width>2</d2p1:Width>
  </SVG>
</ResultWithSVG>