POST web/admin/locker/floorplan/generate-grid

No documentation available.

Request Information

Parameters

Name	Description	Additional information
inVO	No documentation available.	Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "entityType": "sample string 1",
  "entityId": "sample string 2",
  "forEmbed": true,
  "pageSuffix": "sample string 4",
  "curUserId": "sample string 5",
  "isSSO": true,
  "requestHost": "sample string 7",
  "applicationPath": "sample string 8",
  "secureApplicationPath": "sample string 9",
  "absoluteApplicationPath": "sample string 10",
  "isHttps": true,
  "isMobileDevice": true,
  "isElectron": true,
  "isFullEmbed": true,
  "clientType": 0,
  "clientVersion": "sample string 15",
  "clientOS": "sample string 16",
  "clientBuild": "sample string 17",
  "premiumAppId": "sample string 18",
  "clientWidth": 19,
  "clientHeight": 20,
  "timezone": 21,
  "roomId": "sample string 1",
  "rows": 2,
  "cols": 3,
  "codePrefix": "sample string 4",
  "startNumber": 5,
  "zeroPadWidth": 6,
  "defaultGender": "sample string 7",
  "defaultLockType": "sample string 8",
  "lockerWidth": 9,
  "lockerHeight": 10,
  "gap": 11,
  "originX": 12,
  "originY": 13,
  "replaceExisting": true,
  "tiersPerBay": 15,
  "splitLayout": "sample string 16",
  "splitNumbering": "sample string 17",
  "tiers": [
    {
      "lockerTypeId": "sample string 1",
      "suffix": "sample string 2"
    },
    {
      "lockerTypeId": "sample string 1",
      "suffix": "sample string 2"
    },
    {
      "lockerTypeId": "sample string 1",
      "suffix": "sample string 2"
    }
  ],
  "pageType": 0
}

application/xml, text/xml

Sample:

<LockerGenerateGridInVO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Web.API.VO.Input.Locker">
  <ClientHeight xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">20</ClientHeight>
  <ClientType xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">Site</ClientType>
  <ClientWidth xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">19</ClientWidth>
  <absoluteApplicationPath xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 10</absoluteApplicationPath>
  <applicationPath xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 8</applicationPath>
  <cachedKey xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 18</cachedKey>
  <clientBuild xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 17</clientBuild>
  <clientOS xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 16</clientOS>
  <clientVersion xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 15</clientVersion>
  <curUserId xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 5</curUserId>
  <isElectron xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">true</isElectron>
  <isFullEmbed xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">true</isFullEmbed>
  <isHttps xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">true</isHttps>
  <isMobileDevice xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">true</isMobileDevice>
  <isSSO xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">true</isSSO>
  <premiumAppId xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 18</premiumAppId>
  <requestHost xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 7</requestHost>
  <secureApplicationPath xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 9</secureApplicationPath>
  <timezone xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">21</timezone>
  <entityId xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 2</entityId>
  <entityType xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 1</entityType>
  <forEmbed xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">true</forEmbed>
  <pageSuffix xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">sample string 4</pageSuffix>
  <pageType xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Input">FrontPage</pageType>
  <codePrefix>sample string 4</codePrefix>
  <cols>3</cols>
  <defaultGender>sample string 7</defaultGender>
  <defaultLockType>sample string 8</defaultLockType>
  <gap>11</gap>
  <lockerHeight>10</lockerHeight>
  <lockerWidth>9</lockerWidth>
  <originX>12</originX>
  <originY>13</originY>
  <replaceExisting>true</replaceExisting>
  <roomId>sample string 1</roomId>
  <rows>2</rows>
  <splitLayout>sample string 16</splitLayout>
  <splitNumbering>sample string 17</splitNumbering>
  <startNumber>5</startNumber>
  <tiers>
    <LockerGridTierInVO>
      <lockerTypeId>sample string 1</lockerTypeId>
      <suffix>sample string 2</suffix>
    </LockerGridTierInVO>
    <LockerGridTierInVO>
      <lockerTypeId>sample string 1</lockerTypeId>
      <suffix>sample string 2</suffix>
    </LockerGridTierInVO>
    <LockerGridTierInVO>
      <lockerTypeId>sample string 1</lockerTypeId>
      <suffix>sample string 2</suffix>
    </LockerGridTierInVO>
  </tiers>
  <tiersPerBay>15</tiersPerBay>
  <zeroPadWidth>6</zeroPadWidth>
</LockerGenerateGridInVO>

application/x-www-form-urlencoded

Sample:

Sample not available.

multipart/form-data

Sample:

--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="roomId"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="rows"

2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="cols"

3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="codePrefix"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="startNumber"

5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="zeroPadWidth"

6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="defaultGender"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="defaultLockType"

sample string 8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="lockerWidth"

9
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="lockerHeight"

10
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="gap"

11
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="originX"

12
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="originY"

13
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="replaceExisting"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="tiersPerBay"

15
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="splitLayout"

sample string 16
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="splitNumbering"

sample string 17
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="tiers[0].lockerTypeId"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="tiers[0].suffix"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="tiers[1].lockerTypeId"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="tiers[1].suffix"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="tiers[2].lockerTypeId"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="tiers[2].suffix"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="pageType"

FrontPage
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="cachedKey"

sample string 18
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

No documentation available.

Response body formats

application/json, text/json

Sample:

{
  "isDone": true,
  "code": 0,
  "message": "sample string 2",
  "data": {},
  "cachedKey": "sample string 4",
  "correlationId": "23854bc8-95cb-465a-a16c-00afde736d31",
  "jwtTokenForSPA": "sample string 6",
  "jwtTokenIndexForSPA": 1
}

application/xml, text/xml

Sample:

<ResultOutVO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Output.Common">
  <CachedKey>sample string 4</CachedKey>
  <Code>None</Code>
  <CorrelationId>23854bc8-95cb-465a-a16c-00afde736d31</CorrelationId>
  <Data />
  <IsDone>true</IsDone>
  <JwtTokenForSPA>sample string 6</JwtTokenForSPA>
  <JwtTokenIndexForSPA>1</JwtTokenIndexForSPA>
  <Message>sample string 2</Message>
</ResultOutVO>

multipart/form-data

Sample:

Sample not available.