Jump to

• Request
• Response

Set a temporary allow

put

/customercare/v1/{customerId}/provision

Sets a temporary allow for the user.

Request

Path Parameters

• customerId(required): string
  Customer ID (available in the session) of the user.

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: object

Show Source

• expirationDate: string (date-time)
  Date time string in the format rfc3339 sec 5.6. https://tools.ietf.org/html/rfc3339#section-5.6 e.g format 2021-08-13T01:29:29.768Z
• tempAllowType: integer
  Should be one of the enumerated types in customercare.case.tempallow.level.enum

{
    "type":"object",
    "properties":{
        "tempAllowType":{
            "type":"integer",
            "description":"Should be one of the enumerated types in customercare.case.tempallow.level.enum"
        },
        "expirationDate":{
            "$ref":"#/components/schemas/DateTime"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• expirationDate: string (date-time)
  Date time string in the format rfc3339 sec 5.6. https://tools.ietf.org/html/rfc3339#section-5.6 e.g format 2021-08-13T01:29:29.768Z
• tempAllowType: integer
  Should be one of the enumerated types in customercare.case.tempallow.level.enum

{
    "type":"object",
    "properties":{
        "tempAllowType":{
            "type":"integer",
            "description":"Should be one of the enumerated types in customercare.case.tempallow.level.enum"
        },
        "expirationDate":{
            "$ref":"#/components/schemas/DateTime"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success

Body ()

Root Schema : StatusResponse

Type: object

Status information for API call

Show Source

• responseCode: string
  status code of the request
• responseMessage: string
  response message related to the response code if needed.
• sessionId: string
  session id of the authentcation.
• status: boolean
  authentication update request status

{
    "type":"object",
    "description":"Status information for API call",
    "properties":{
        "responseCode":{
            "type":"string",
            "description":"status code of the request"
        },
        "responseMessage":{
            "type":"string",
            "description":"response message related to the response code if needed."
        },
        "status":{
            "type":"boolean",
            "description":"authentication update request status"
        },
        "sessionId":{
            "type":"string",
            "description":"session id of the authentcation."
        }
    }
}

400 Response

Invalid input

404 Response

Customer ID not found

Back to Top