POST Sessions

Create a new session for interaction with this API.
The response message contains two tokens, one of which must be passed in a header for all other operations with this API.
You may either use the bearerToken or the authenticationToken. Either send a header with key "authentication" and value the authenticationToken returned in this response, or send a header with key "Authorization" and value the bearerToken returned in this response.
The bearerToken does not expire, but will become invalid if the user's credentials change.
The authenticationToken remains valid until no request is sent to this API using the authenticationToken for 30 minutes.

Request Information

URI Parameters

None.

Body Parameters

The credentials for the session.

NewSessionRequest
NameDescriptionTypeAdditional information
account

The id of the Ascribe account. This is the id entered in the Account section of the logon page in Ascribe.

string

Required

userName

The logon name of the user. The created session will have this user associated with it. Any Inspections created during this session will have this user as the owner of the new Inspection.

string

Required

password

The user's password.

string

Required

Response Information

Create a new session for interaction with this API.
The response message contains two tokens, one of which must be passed in a header for all other operations with this API.
You may either use the bearerToken or the authenticationToken. Either send a header with key "authentication" and value the authenticationToken returned in this response, or send a header with key "Authorization" and value the bearerToken returned in this response.
The bearerToken does not expire, but will become invalid if the user's credentials change.
The authenticationToken remains valid until no request is sent to this API using the authenticationToken for 30 minutes.

NewSessionResponse
NameDescriptionTypeAdditional information
authenticationToken

This value must be sent in the authentication header of all interactions with the API.
Pass this in a header with key "authentication", whose value is the token returned in this field.

globally unique identifier

Required

bearerToken

The bearer token must be sent in the Authorization header.
Pass this in a header with key "authorization", whose value is the token returned in this field.

string

Required

errors

If null the request was processed without error. If not null errors occurred while processing the request. The array contains the error messages.

Collection of string

None.