POST api/keys/AuthorisationList

Gets list of authorised users

Request Information

URI Parameters

None.

Body Parameters

AuthorisationListRequestBindingModel
NameDescriptionTypeAdditional information
boatNo

As name suggests

integer

None.

accountCode

As name suggests

string

None.

marinaCode

As name suggests

string

None.

Request Formats

application/json, text/json

Sample:
{
  "boatNo": 1091,
  "accountCode": "HSML0055",
  "marinaCode": "WEB"
}

multipart/form-data

Sample:
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="boatNo"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="accountCode"

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

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

Resource Description

AuthorisationListBindingModel
NameDescriptionTypeAdditional information
AuthorisedUsers

List of Authorised users

Collection of AuthorisedUsersBindingModel

None.

Response Formats

application/json, text/json

Sample:
{
  "authorisedUsers": [
    {
      "keyAuthID": 1,
      "contactName": "sample string 2",
      "relationshipId": 3,
      "validFrom": "sample string 4",
      "expiryDate": "sample string 5"
    },
    {
      "keyAuthID": 1,
      "contactName": "sample string 2",
      "relationshipId": 3,
      "validFrom": "sample string 4",
      "expiryDate": "sample string 5"
    }
  ]
}

multipart/form-data

Sample:
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="AuthorisedUsers[0].keyAuthID"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="AuthorisedUsers[0].contactName"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="AuthorisedUsers[0].relationshipId"

3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="AuthorisedUsers[0].validFrom"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="AuthorisedUsers[0].expiryDate"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="AuthorisedUsers[1].keyAuthID"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="AuthorisedUsers[1].contactName"

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

3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="AuthorisedUsers[1].validFrom"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="AuthorisedUsers[1].expiryDate"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e--